Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query the information of sites that you have access to. You can filter sites based on different query criteria.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeZones. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| Offset | No | Integer | The page offset. Default value: 0 |
| Limit | No | Integer | Limit on paginated queries. Default value: 20. Maximum value: 100. |
| Filters.N | No | Array of AdvancedFilter | Filter criteria. the maximum number of Filters.Values is 20. if this parameter is left empty, it returns all authorized site information under the current appid. the detailed filter criteria are as follows: ??full: NS access type; ??partial: CNAME-based; ??partialComposite: no domain access; ??dnsPodAccess: DNSPod managed access; ??pages: pages access type; ??ai: edge reasoning access type. ??active: NS switchover completed; ??pending: NS to be switched; ??deleted: has been deleted. |
| Order | No | String | Sort the returned results according to this field. Values include:type: Connection modearea: Acceleration regioncreate-time: Creation timezone-name: Site nameuse-time: Last used timeactive-status Effective statuscreate-time |
| Direction | No | String | Sort direction. If the field value is a number, sort by the numeric value. If the field value is text, sort by the ascill code. Values include:asc: From the smallest to largestdesc: From the largest to smallest.desc |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of eligible sites. |
| Zones | Array of Zone | Describes the list details of sites. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Query site information with the exact site name "example.com".
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZones
<Common request parameters>
{
"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",
"NSDetail": {
"CnameSpeedUp": "enabled",
"IsFake": 0,
"NameServers": [
"ns1.teodns.com.",
"ns2.teodns.com."
],
"OriginalNameServers": [
"ns1.example.com.",
"ns2.example.com."
],
"VanityNameServers": {
"Switch": "on",
"Servers": [
"ns1.teodns.com.",
"ns2.teodns.com."
]
},
"VanityNameServersIps": []
},
"CNAMEDetail": {
"IsFake": 0
},
"DNSPodDetail": null,
"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": [],
"WorkModeInfos": [
{
"ConfigGroupType": "l7_acceleration",
"WorkMode": "version_control"
},
{
"ConfigGroupType": "edge_functions",
"WorkMode": "version_control"
},
{
"ConfigGroupType": "web_security",
"WorkMode": "immediate_effect"
}
]
}
],
"RequestId": "641a08e3-2ef7-407c-9c2f-2a9928741df5"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.ProxyServer | An unknown error occurred in the backend server. |
| OperationDenied | Operation denied. |
| UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
| UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |
| UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |
文档反馈