DescribeDomainsConfig

Last updated: 2020-05-29 11:13:58

1. API Description

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

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.

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 the detailed configuration of a domain name

Input Example

https://ecdn.tencentcloudapi.com/?Action=DescribeDomainsConfig
&<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": [
                "gif",
                "png",
                "bmp",
                "jpg",
                "jpeg",
                "mp3",
                "wma",
                "flv",
                "mp4",
                "wmv",
                "avi",
                "m3u8",
                "ts"
              ],
              "CacheTime": 86400
            },
            {
              "CacheType": "file",
              "CacheContents": [
                "doc",
                "docx",
                "xls",
                "xlsx",
                "ppt",
                "pptx",
                "txt",
                "pdf"
              ],
              "CacheTime": 86400
            },
            {
              "CacheType": "file",
              "CacheContents": [
                "exe",
                "apk",
                "ipa",
                "rar",
                "zip",
                "7z",
                "css",
                "js",
                "xml",
                "ini",
                "swf",
                "ico"
              ],
              "CacheTime": 86400
            }
          ]
        },
        "CacheKey": {
          "FullUrlCache": "on"
        },
        "Cname": "test.com.com.dsa.dnsv1.com",
        "CreateTime": "2019-12-03 15:23:50",
        "Disable": "normal",
        "Domain": "test.com",
        "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": [
            "1.1.1.1"
          ],
          "OriginType": "ip",
          "ServerName": null,
          "OriginPullProtocol": "http",
          "BackupOrigins": [],
          "BackupOriginType": null,
          "BackupServerName": null
        },
        "ProjectId": 0,
        "Readonly": "normal",
        "ResourceId": "ecdn-xxxxxx",
        "ResponseHeader": {
          "HeaderRules": [],
          "Switch": "off"
        },
        "Status": "processing",
        "StrategyWeight": null,
        "UpdateTime": "2019-12-03 15:23:50"
      }
    ],
    "TotalCount": 10
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
FailedOperation.EcdnConfigError Failed to update the domain name configuration. Please try again or contact customer service for assistance.
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.
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.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help