1. 接口描述
接口请求域名: teo.tencentcloudapi.com 。
该接口用于查询您有权限的站点信息。可根据不同查询条件筛选站点。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeZones。 |
Version | 是 | String | 公共参数,本接口取值:2022-09-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Offset | 否 | Integer | 分页查询偏移量。默认值:0。 |
Limit | 否 | Integer | 分页查询限制数目。默认值:20,最大值:100。 |
Filters.N | 否 | Array of AdvancedFilter | 过滤条件,Filters.Values 的上限为 20。该参数不填写时,返回当前 appid 下有权限的所有站点信息。详细的过滤条件如下: |
Order | 否 | String | 可根据该字段对返回结果进行排序,取值有: |
Direction | 否 | String | 排序方向,如果是字段值为数字,则根据数字大小排序;如果字段值为文本,则根据 ascill 码的大小排序。取值有: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的站点个数。 |
Zones | Array of Zone | 站点详细信息。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户站点信息列表
精确查询站点名称为“example.com”的站点信息。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZones
<公共请求参数>
{
"Filters": [
{
"Name": "zone-name",
"Values": [
"example.com"
],
"Fuzzy": false
}
]
}
输出示例
{
"Response": {
"TotalCount": 1,
"Zones": [
{
"ZoneId": "zone-2noz3g48ev6k",
"ZoneName": "example.com",
"ActiveStatus": "inactive",
"AliasZoneName": "",
"Area": "global",
"CnameSpeedUp": "enabled",
"CnameStatus": "pending",
"CreatedOn": "2023-09-18T07:41:05Z",
"IsFake": 0,
"LockStatus": "enable",
"ModifiedOn": "2023-09-18T07:41:50Z",
"NameServers": [
"ns1.teodns.com.",
"ns2.teodns.com."
],
"OriginalNameServers": [
"ns1.example.com.",
"ns2.example.com."
],
"Paused": false,
"Resources": [
{
"Area": "global",
"AutoRenewFlag": 0,
"CreateTime": "2023-09-18T07:41:18Z",
"EnableTime": "2023-09-18T07:41:18Z",
"ExpireTime": "2099-12-31T15:59:59Z",
"Group": "plan",
"Id": "edgeone-2noz3qqkvqth",
"PayMode": 0,
"PlanId": "edgeone-2noz3qqkvqth",
"Status": "normal",
"Sv": [
{
"Key": "sv_edgeone_plan_sec_ent_flatfee_cm",
"Value": "1",
"InstanceId": "",
"Pack": "",
"ProtectionSpecs": ""
}
]
},
{
"Area": "global",
"AutoRenewFlag": 0,
"CreateTime": "2023-09-18T07:41:18Z",
"EnableTime": "2023-09-18T07:41:18Z",
"ExpireTime": "2099-12-31T15:59:59Z",
"Group": "pay-as-you-go",
"Id": "edgeone-2noz3t4be7xw",
"PayMode": 0,
"PlanId": "edgeone-2noz3qqkvqth",
"Status": "normal",
"Sv": [
{
"Key": "sv_edgeone_sec_request_queries_month",
"Value": "1",
"InstanceId": "",
"Pack": "",
"ProtectionSpecs": ""
},
{
"Key": "sv_edgeone_va_unit_month",
"Value": "1",
"InstanceId": "",
"Pack": "",
"ProtectionSpecs": ""
}
]
}
],
"Status": "pending",
"Tags": [],
"Type": "full",
"VanityNameServers": null,
"VanityNameServersIps": []
}
],
"RequestId": "641a08e3-2ef7-407c-9c2f-2a9928741df5"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.ProxyServer | 后端服务器发生未知错误。 |
OperationDenied | 操作被拒绝。 |
UnauthorizedOperation.CamUnauthorized | Cam 未授权。 |
UnauthorizedOperation.NoPermission | 子账户没有操作权限,请添加权限后继续操作。 |
UnauthorizedOperation.Unknown | 后端服务器发生未知错误。 |