tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDomains

Last updated: 2022-02-23 10:16:38

1. API Description

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

This API is used to query the basic information of a CDN domain name, including the project ID, status, business type, creation time, update time, etc.

Note：

If you have migrated your ECDN service to CDN, you can use the corresponding CDN API.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeDomains.
Version Yes String Common parameter. The value used for this API: 2019-10-12.
Region No String Common parameter. This parameter is not required for this API.
Offset No Integer Pagination offset address. Default value: 0.
Limit No Integer Number of domain names per page. Default value: 100. Maximum value: 1000.
Filters.N No Array of DomainFilter Query filter.

3. Output Parameters

Parameter Name Type Description
Domains Array of DomainBriefInfo Domain name information list.
TotalCount Integer Total number of domain names.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the basic information of domain names

Input Example

https://ecdn.tencentcloudapi.com/?Action=DescribeDomains
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "104fcdb5-293c-4f6f-b63d-0c9e430264e3",
    "Domains": [
      {
        "AppId": 1251000000,
        "Area": "mainland",
        "Cname": "test.com.dsa.dnsv1.com",
        "CreateTime": "2019-12-03 15:23:50",
        "Disable": "normal",
        "Domain": "test.com",
        "Tag": [],
        "Origin": {
          "Origins": [
            "1.1.1.1"
          ],
          "OriginType": "ip",
          "ServerName": null,
          "OriginPullProtocol": "http",
          "BackupOrigins": [],
          "BackupOriginType": null
        },
        "ProjectId": 0,
        "Readonly": "normal",
        "ResourceId": "ecdn-xxxx",
        "Status": "processing",
        "UpdateTime": "2019-12-03 15:23:50"
      }
    ],
    "TotalCount": 10
  }
}

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
InternalError.EcdnConfigError Internal configuration service error. Please try again later or contact the customer service for assistance.
InternalError.EcdnDbError Internal data error. Please submit a ticket for troubleshooting.
InternalError.EcdnSystemError System error. Please submit a ticket for troubleshooting.
InvalidParameter.EcdnInterfaceError Internal API error. Please submit a ticket for troubleshooting.
InvalidParameter.EcdnParamError Parameter error. Please see the sample parameters in the documentation.
LimitExceeded.EcdnDomainOpTooOften Domain name operations are too frequent.
ResourceNotFound.EcdnDomainNotExists This domain name does not exist under the account. Please check and try again.
ResourceNotFound.EcdnUserNotExists The ECDN service has not been activated. Please activate it first before using this API.
UnauthorizedOperation.EcdnCamUnauthorized No CAM policy is configured for the sub-account.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy