Last updated: 2021-03-31 14:42:15

1. API Description

Domain name for API request:

This API is used to query the detailed configuration information of a CDN acceleration domain name.

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 parameter. The value used for this API: DescribeDomainsConfig.
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.
Filters.N No Array of DomainFilter Query filter.
Sort No Sort Query result sorting rule.

3. Output Parameters

Parameter Name Type Description
Domains Array of DomainDetailInfo Domain name list.
TotalCount Integer Number of matched domain names. This is used for paginated query.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying domain name configuration

Input Example
&<Common request parameters>

Output Example

  "Response": {
    "RequestId": "932fe708-0ce1-46ec-b403-bcd8bdb08fdd",
    "Domains": [
        "AppId": 1251000000,
        "Area": "mainland",
        "Cache": {
          "CacheRules": [
              "CacheType": "all",
              "CacheContents": [
              "CacheTime": 0
              "CacheType": "file",
              "CacheContents": [
              "CacheTime": 86400
              "CacheType": "file",
              "CacheContents": [
              "CacheTime": 86400
              "CacheType": "file",
              "CacheContents": [
              "CacheTime": 86400
        "CacheKey": {
          "FullUrlCache": "on"
        "Cname": "",
        "CreateTime": "2019-12-03 15:23:50",
        "Disable": "normal",
        "Domain": "",
        "ForceRedirect": null,
        "Https": {
          "Switch": "off",
          "Http2": "off",
          "Spdy": "off",
          "OcspStapling": "off",
          "VerifyClient": "off",
          "CertInfo": null,
          "ClientCertInfo": null,
          "SslStatus": "closed"
        "IpFilter": {
          "Switch": "off",
          "FilterType": "blacklist",
          "Filters": []
        "IpFreqLimit": {
          "Switch": "off",
          "Qps": null
        "Origin": {
          "Origins": [
          "OriginType": "ip",
          "ServerName": null,
          "OriginPullProtocol": "http",
          "BackupOrigins": [],
          "BackupOriginType": null
        "ProjectId": 0,
        "Readonly": "normal",
        "ResourceId": "ecdn-xxxxxx",
        "ResponseHeader": {
          "HeaderRules": [],
          "Switch": "off"
        "Status": "processing",
        "UpdateTime": "2019-12-03 15:23:50"
    "TotalCount": 10

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 Code Description
FailedOperation.EcdnConfigError Failed to update the domain name configuration. Please try again or contact customer service for assistance.
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.EcdnCertNoCertInfo Unable to resolve the certificate information.
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.