tencent cloud

文档反馈

DescribeZones

最后更新时间:2023-03-09 17:41:38

1. API Description

Domain name for API request: teo.tencentcloudapi.com.

This API is used to query the list of user sites.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Offset No Integer Pagination parameter, which specifies the offset.
Limit No Integer Pagination parameter, which specifies the number of sites returned in each page.
Filters.N No Array of ZoneFilter Query condition filter, which supports complex type.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of sites that match the specified conditions
Zones Array of Zone Details of sites
Note: This field may return null, indicating that no valid value can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Query the list of user sites

Input Example

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeZones
<Common request parameters>

{}

Output Example

{
    "Response": {
        "Zones": [
            {
                "Status": "xx",
                "ModifiedOn": "2020-09-22T00:00:00+00:00",
                "Name": "xx",
                "NameServers": [
                    "xx"
                ],
                "CreatedOn": "2020-09-22T00:00:00+00:00",
                "OriginalNameServers": [
                    "xx"
                ],
                "Paused": true,
                "Type": "xx",
                "Id": "xx"
            }
        ],
        "TotalCount": 0,
        "RequestId": "xx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
OperationDenied Operation denied.
UnauthorizedOperation.CamUnauthorized CAM is not authorized.
UnauthorizedOperation.NoPermission The sub-account is not authorized for the operation. Please get permissions first.