Overview
Menu

DescribeZones

1. API Description

Domain name for API request: teo.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.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeZones.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
OffsetNoIntegerThe page offset. Default value: 0
LimitNoIntegerLimit on paginated queries. Default value: 20. Maximum value: 100.
Filters.NNoArray of AdvancedFilterFilter conditions. Up to 20 values for each filter. If this parameter is not filled in, the information of all sites under the current account is returned. Detailed filtering conditions are as follows:
  • zone-name: Site name
  • zone-id: Site ID, such as zone-2noz78a8ev6k
  • status: Site status
  • tag-key: Tag key
  • tag-value: Tag value
  • Only zone-name supports fuzzy query.
    OrderNoStringSort the returned results according to this field. Values include:
  • type: Connection mode
  • area: Acceleration region
  • create-time: Creation time
  • zone-name: Site name
  • use-time: Last used time
  • active-status Effective status
  • Default value: create-time
    DirectionNoStringSort 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 largest
  • desc: From the largest to smallest.
  • Default value: desc

    3. Output Parameters

    Parameter NameTypeDescription
    TotalCountIntegerNumber of eligible sites.
    ZonesArray of ZoneDetails of sites.
    RequestIdStringThe 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.

    4. Example

    Example1 Querying the list of user sites

    Query information of the site "example.com".

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeZones
    <Common request parameters>
    
    {
        "Filters": [
            {
                "Name": "zone-name",
                "Values": [
                    "example.com"
                ],
                "Fuzzy": false
            }
        ]
    }
    

    Output Example

    {
        "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. 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 CodeDescription
    InternalError.ProxyServerAn unknown error occurred in the backend server.
    OperationDeniedOperation denied.
    UnauthorizedOperation.CamUnauthorizedCAM is not authorized.
    UnauthorizedOperation.NoPermissionThe sub-account is not authorized for the operation. Please get permissions first.
    UnauthorizedOperation.UnknownAn unknown error occurred in the backend server.