DescribeDomains

1. API Description

This interface is used to query information about multiple accelerated domain names. Users can query based on conditions such as ID or name.

2. Request Parameters

The following request parameter list includes only the necessary parameters for the interface

Parameter Name	Required	Type	Description
domainIds	No	Array of String	Accelerated domain IDs. Supports up to 100 IDs for querying.
domainName	No	String	Accelerated domain name
domainStatus	No	String	Accelerated domain status
configStatus	No	String	Domain configuration status
accelerationRegionId	No	String	Acceleration region ID
businessTypeId	No	String	Business type ID
resourceGroupId	No	String	Resource group ID. If not provided, returns instances in all visible resource groups.
pageSize	No	Integer	Size of the returned page. Defaults to 20, maximum is 1000.
pageNum	No	Integer	Page number of the returned data. Defaults to 1.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	Unique request ID, returned with each request. Provide this requestId when locating issues.
totalCount	Integer	Total number of data that meets the conditions.
dataSet	Array of DomainInfo	Result set.

4. Code Example

Example

1. Paginate through the list of accelerated domains

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

Request:
{
  "pageNum": 1,
  "pageSize": 1
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "totalCount": 6,
    "dataSet": [
          {
            "domainId": "domainIdxxxxx",
            "businessType": "LF",
            "domainName": "cdntest.zenlayer.com",
            "domainStatus": "DEPLOYED",
            "configStatus": "ENABLED",
            "cname": "xxx.zga.globalconnetct.com",
            "createTime": "2023-04-28T03:38:53Z",
            "resourceGroupId":"xxx-xx"
          }
    ]
  }
}

5. Error Codes

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