GetPagingDomainList
Update time: 2026-08-18 18:17:41
Applicable Products
Content Acceleration,Dynamic Web Acceleration,Media Acceleration VoD,Media Acceleration Live Broadcast
API Description
Queries all, or specified, acceleration domains and states under the user's account. Each acceleration domain name contains profile information. The returned accelerated domain name list is sorted by version.
- API URL: https://api.atomile.com/api/domain/list
- Method: POST
Call frequency
Single user trigger frequency: 1/15min
Request parameter(s)
Body Params
| Name | Description |
|---|---|
pageNumberInteger | Page number must be a positive integer greater than 0.If not passed, then no paging. If it is passed, pageSize is required. |
pageSizeInteger | Number of domain name data items for paging, must be a positive integer greater than 0.If not passed, then no paging. If it is passed, pageSize is required. |
serviceTypesList | Specify the service type to be queried. Multiple services are allowed. Data will be returned if any one service is satisfied. If not passed, all services will be checked by default. For example: [wsa,waf], returns all domains whose services include wsa or include waf. |
domainNamesList | Specify the accelerated domain name for the query. Multiple domain names are allowed. If not specified, all domain names will be searched by default. |
startTimeString | Query by creation time of the domain. The starting time in RFC3339 format, supporting any timezone offset. Examples: UTC 2024-01-01T14:30:00+00:00; UTC+8 2024-01-01T22:30:00+08:00 |
endTimeString | Query by creation time of the domain. The ending time in RFC3339 format, supporting any timezone offset. Examples: UTC 2024-01-01T14:30:00+00:00; UTC+8 2024-01-01T22:30:00+08:00 |
statusString | Status of the accelerated domain. Optional value: enabled, disabled, deploying, checking, disabling, deployFailed, disableFailed. |
Response parameter(s)
Response Header
| Name | Description |
|---|---|
codeInteger | httpstatus=202; Indicates that the new domain API was successfully invoked, and the current deployment of the new domain can be viewed using x-cnc-request-id in the header |
x-cnc-request-idString | Uniquely identified id for querying tasks per request (for all API) |
Body Params
| Name | Description |
|---|---|
totalCountInteger | Responses the page number of the data |
totalPageNumberInteger | total pages |
pageNumberInteger | Responses the page number of the data |
pageSizeInteger | Number of data page |
resultListList | Domain list. |
cnameString | Cname of the accelerated domain |
createTimeString | Creation time of the accelerated domain in RFC3339 format. The timezone of the returned value follows the tenant default timezone or the timezone of the query parameters. Examples: UTC 2024-01-01T14:30:00+00:00; UTC+8 2024-01-01T22:30:00+08:00 |
domainIdString | Corresponding domain ID |
domainNameString | Accelerated domain name |
serviceTypesList | Service type for accelerated domain name |
statusString | Status of the accelerated domain. Optional value: enabled, disabled, deploying, checking, disabling. |
enabledString | Accelerated domain enabling status: true indicates that it is enabled, false indicates that it is disabled. |
Error code
| Error code(code) | Description(message) | HTTP status | Semantic |
|---|---|---|---|
| 0 | success | 202 | success |
| 26938005 | 1.The specify pageNumber must great than 0.\n2.The specify pageSize must great than 0.\n3.The specify status is invalid.\n4.One of the pageNumber or pageSize can not be null. | 400 | 1.The specify pageNumber must great than 0.\n2.The specify pageSize must great than 0.\n3.The specify status is invalid.\n4.One of the pageNumber or pageSize can not be null. |
| 19638005 | 1.The specify startTime is invalid.\n2.The specify endTime is invalid. | 400 | 1.The specify startTime is invalid.\n2.The specify endTime is invalid. |
| 19636001 | Wrong customer name.\n\n | 400 | Wrong customer name.\n\n |
| 19636003 | Wrong operator | 400 | Wrong operator |
Example
JSON
- Request example Copy success
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` curl -i --url "http://{@apiDomain}/api/domain/list" \ -X "POST" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \ -d '{ "serviceTypes": ["web"], "pageNumber": 1, "pageSize": 15, "domainNames": ["a1.example.com","a2.example.com"], "startTime": "2024-01-01T14:30:00+00:00", "endTime": "2024-01-01T22:30:00+00:00", "status": "enabled" }'- Response example Copy success
HTTP/1.1 200 OK Date: Fri, 05 Jan 2024 06:52:13 GMT Content-Type: application/json;charset=utf-8 Content-Length: 6046 Connection: keep-alive Server: openresty/1.11.2.2 App-Name: service_confApi x-cnc-request-id: ca933c0a-dcae-4ed7 x-cnc-process-time: 0.14 X-Ws-Request-Id: 6597a71d_CS-000-01MnD38_27457-7696 { "totalCount": 2, "pageNumber": 1, "pageSize": 100, "totalPageNumber": 1, "resultList": [ { "domainId": "50659", "domainName": "a1.example.com", "serviceTypes": ["web"]， "cname": "a1.example.com.wscdns.com", "status":"deployed", "enabled":"true", "createTime": "2024-01-01T14:30:00+00:00" } ] }