DescribeDomainCaches

1. API Description

This interface is used to query the cache policy for an accelerated domain.

Note

  • This is an asynchronous interface. After a successful response from this interface, the creation of the accelerated domain operation is not immediately complete. During this period, the status of the accelerated domain will be Deploying. You can query the status of the accelerated domain by calling the DescribeCdnDomains interface. If the accelerated domain status (domainStatus) changes from Deploying (deploying) to Deployed (deployment successful), it means the deployment was successful; Failed indicates a configuration failure.

2. Request Parameters

The following request parameters are required by the interface:

Parameter NameRequiredTypeDescription

domainId

Yes

String

Accelerated domain ID

3. Output Parameters

Parameter NameTypeDescription

requestId

String

Unique request ID. This ID is returned with every request and is needed for troubleshooting.

caches

CacheInfo

Array of CacheInfo

4. Code Example

  1. Query Accelerated Domain Cache Policy

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/cdn
Content-Type: application/json
X-ZC-Action: DescribeDomainCaches
<Common Request Params>

Request:
{
    "domainId": "domainIdxxxxx"
}

Response:
{
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "response": {
        "requestId": "T6883FCD0-3E7D-44EA-A517-A421A52A27F4",
        "caches": [{
            "cacheId": "cacheIdxxxxxx",
            "cacheType": "FILE",
            "cacheTime": 7,
            "timeUnit": "SECONDS",
            "priority": 99,
            "content": "txt|css|js",
            "directory": ""
        }]
    }
}

5. Error Codes

The following includes error codes encountered in business logic. For other error codes, see Common Error Codes.

HTTP Status CodeError CodeDescription

404

INVALID_DOMAIN_NOT_FOUND

The specified accelerated domain does not exist.

403

DOMAIN_OPERATION_NO_PERMISSION

Operation denied due to lack of permission.

Last updated