tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud EdgeOne
    Documentation

    DescribeZoneDetails

    Last updated: 2023-03-09 17:41:38

    1. API Description

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

    This API is used to query the details of a site by site ID.

    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: DescribeZoneDetails.
    Version Yes String Common Params. The value used for this API: 2022-01-06.
    Region No String Common Params. This parameter is not required for this API.
    Id Yes String Site ID

    3. Output Parameters

    Parameter Name Type Description
    Id String Site ID
    Name String Site name
    OriginalNameServers Array of String List of name servers used
    Note: This field may return null, indicating that no valid value can be obtained.
    NameServers Array of String List of name servers assigned to users by Tencent Cloud
    Note: This field may return null, indicating that no valid value can be obtained.
    Status String Site status
    - active: The name server is switched.
    - pending: The name server is not switched.
    - moved: The name server is moved.
    - deactivated: The name server is blocked.
    Type String Specifies how the site is connected to EdgeOne.
    - full: The site is connected via name server.
    - partial: The site is connected via CNAME.
    Paused Boolean Indicates whether the site is disabled
    CnameSpeedUp String Specifies whether to enable CNAME acceleration
    - enabled: Enable
    - disabled: Disable
    CnameStatus String Ownership verification status of the site when it accesses via CNAME.
    - finished: The site is verified.
    - pending: The site is waiting for verification.
    Note: This field may return null, indicating that no valid value can be obtained.
    Tags Array of Tag Resource tag
    Note: This field may return null, indicating that no valid values can be obtained.
    Area String
    Resources Array of Resource Billable resource
    Note: This field may return null, indicating that no valid values can be obtained.
    ModifiedOn Timestamp ISO8601 Site modification date
    CreatedOn Timestamp ISO8601 Site creation date
    VanityNameServers VanityNameServers User-defined name server information
    Note: This field may return null, indicating that no valid value can be obtained.
    VanityNameServersIps Array of VanityNameServersIps User-defined name server IP information
    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 Querying the details of a site

    Input Example

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

{
    "Id": "xx"
}

    Output Example

    {
    "Response": {
        "Status": "xx",
        "ModifiedOn": "2020-09-22T00:00:00+00:00",
        "Name": "xx",
        "Tags": [
            {
                "TagKey": "xx",
                "TagValue": "xx"
            }
        ],
        "NameServers": [
            "xx"
        ],
        "VanityNameServers": {
            "Switch": "xx",
            "Servers": [
                "xx"
            ]
        },
        "CreatedOn": "2020-09-22T00:00:00+00:00",
        "OriginalNameServers": [
            "xx"
        ],
        "Paused": true,
        "CnameSpeedUp": "xx",
        "Resources": [
            {
                "EnableTime": "2020-09-22T00:00:00+00:00",
                "Status": "xx",
                "ExpireTime": "2020-09-22T00:00:00+00:00",
                "PlanId": "xx",
                "Sv": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "CreateTime": "2020-09-22T00:00:00+00:00",
                "PayMode": 0,
                "AutoRenewFlag": 0,
                "Id": "xx"
            }
        ],
        "RequestId": "xx",
        "Type": "xx",
        "Id": "xx",
        "VanityNameServersIps": [
            {
                "Name": "xx",
                "IPv4": "xx"
            }
        ],
        "CnameStatus": "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.
    ResourceNotFound The resource doesn’t exist.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy