Last updated: 2021-03-19 16:45:24

1. API Description

Domain name for API request:

This API is used to query the complete configuration information of CDN acceleration domain names (inside and outside mainland China).

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: 2018-06-06.
Region No String Common parameter. This parameter is not required for this API.
Offset No Integer Offset for paginated queries. Default value: 0
Limit No Integer Limit on paginated queries. Default value: 100. Maximum value: 1000.
Filters.N No Array of DomainFilter Query condition filter, complex type.
Sort No Sort Sorting rules

3. Output Parameters

Parameter Name Type Description
Domains Array of DetailDomain List of domain names
TotalNumber Integer The number of domain names that matched the query conditions
Used for paginated queries
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": "ba516c05-42d9-49c7-b275-7775be0475ba",
    "Domains": [
        "Area": "mainland",
        "Authentication": {
          "Switch": "off",
          "TypeA": null,
          "TypeB": null,
          "TypeC": null,
          "TypeD": null
        "BandwidthAlert": {
          "Switch": "off",
          "BpsThreshold": 10000000000,
          "CounterMeasure": "RETURN_404",
          "LastTriggerTime": null
        "Cache": {
          "SimpleCache": {
            "CacheRules": [
                "CacheType": "all",
                "CacheContents": [
                "CacheTime": 2592000
            "IgnoreCacheControl": "off",
            "IgnoreSetCookie": "off",
            "CompareMaxAge": "off",
            "FollowOrigin": "off"
          "AdvancedCache": null
        "CacheKey": {
          "FullUrlCache": "on"
        "Cname": "",
        "Compatibility": {
          "Code": 0
        "Compression": {
          "Switch": "off",
          "CompressionRules": [
              "Compress": true,
              "FileExtensions": [
              "MinLength": 256,
              "MaxLength": 2097152,
              "Algorithms": [
        "CreateTime": "2019-11-15 15:20:46",
        "Disable": "normal",
        "Domain": "",
        "DownstreamCapping": {
          "Switch": "off",
          "CappingRules": []
        "ErrorPage": {
          "PageRules": [],
          "Switch": "off"
        "FollowRedirect": {
          "Switch": "on"
        "ForceRedirect": {
          "Switch": "off",
          "RedirectType": "http",
          "RedirectStatusCode": 302
        "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
        "Ipv6": {