EdgeOne Logo


1. API Description

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

This API is used to query domain name information of a site, including the acceleration domain name, origin, and domain name status. You can query the information of all domain names, or specific domain names by specifying filters information.

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: DescribeAccelerationDomains.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringID of the site related with the acceleration domain name.
OffsetNoIntegerOffset for paginated queries. Default value: 0.
LimitNoIntegerLimit on paginated queries. Default value: 20. Maximum value: 200.
Filters.NNoArray of AdvancedFilterFilter conditions. The maximum value of Filters.Values is 20. If it is not specified, all domains related with the specific zone-id are returned.
  • domain-name: Filtering based on the acceleration domain name
  • origin-type: Filtering based on the type of the origin server
  • origin: Filtering based on the primary origin server address
  • backup-origin: Filtering based on the secondary origin server address
  • domain-cname: Filtering based on the CNAME
  • share-cname: Filtering based on the shared CNAME
  • vodeo-sub-app-id: Filtering based on [vodeo sub-application ID]
  • vodeo-distribution-range: Filtering based on [vodeo distribution range]
  • vodeo-bucket-id: Filtering based on [vodeo storage bucket ID];
  • OrderNoStringSort the returned results according to this field. Values include:
  • created_on: Creation time of the acceleration domain name
  • domain-name: (Default) Acceleration domain name.
  • DirectionNoStringSort direction. If the field value is number, sort by the numeric value. If the field value is text, sort by the ascill code. Values include:
  • asc: Ascending order.
  • desc: Descending order.
  • Default value: asc.
    MatchNoStringThe match mode. Values:
  • all: Return all matches.
  • any: Return any match.
  • Default value: all.

    3. Output Parameters

    Parameter NameTypeDescription
    TotalCountIntegerTotal of matched alias domain names.
    AccelerationDomainsArray of AccelerationDomainInformation of all matched acceleration domain names
    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 information of domain names under a site

    Query the information of all acceleration domain names with the origin type of IP_DOMAIN of a specific site by specifying the zone-id, and sort the results in descending order by the creation time.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAccelerationDomains
    <Common request parameters>
        "ZoneId": "zone-20hyebgyfsko",
        "Filters": [
                "Fuzzy": true,
                "Values": [
                "Name": "origin-type"
        "Direction": "desc",
        "Order": "created_on",
        "Match": "all"

    Output Example

        "Response": {
            "TotalCount": 1,
            "AccelerationDomains": [
                    "ZoneId": "zone-20hyebgyfsko",
                    "DomainName": "www.qq.com",
                    "DomainStatus": "online",
                    "OriginDetail": {
                        "OriginType": "IP_DOMAIN",
                        "Origin": "origin.qq.com",
                        "BackupOrigin": "",
                        "PrivateParameters": [],
                        "PrivateAccess": "",
                        "OriginGroupName": "",
                        "BackOriginGroupName": ""
                    "IdentificationStatus": "finished",
                    "Cname": "www.qq.com.eo.dnse3.com",
                    "CreatedOn": "2020-09-22T00:00:00+00:00",
                    "ModifiedOn": "2020-09-22T00:00:00+00:00"
            "RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"

    5. Developer Resources


    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
    FailedOperationOperation failed.
    InternalError.ProxyServerAn unknown error occurred in the backend server.
    InvalidParameter.DomainOnTrafficSchedulingTraffic scheduling is already enabled for the current domain name.
    InvalidParameter.TooManyFilterValuesToo many filter values.
    OperationDeniedOperation denied.
    ResourceNotFoundThe resource doesn’t exist.
    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.