Queries all accelerated domain names in your Alibaba Cloud account and the status of the accelerated domain names. You can filter domain names by name or status. Fuzzy match is supported.
Operation description
- You can call this operation up to 100 times per second per account.
- You can specify up to 50 domain names in each request. Separate multiple domain names with commas (,).
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cdn:DescribeUserDomains | READ |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 500. Default value: 20. Maximum value: 500. | 5 |
| PageNumber | integer | No | The page number. Valid values: 1 to 100000. | 1 |
| DomainName | string | No | The accelerated domain. If you do not set this parameter, all domain names that match the conditions are returned. | example.com |
| DomainStatus | string | No | The status of the domain name. Valid values:
If you do not set this parameter, domain names in all states are queried. | configure_failed |
| DomainSearchType | string | No | The search mode. Valid values:
Note
If you specify the domain names to query but do not set the DomainSearchType parameter, the exact match mode is used.
| fuzzy_match |
| CdnType | string | No | The type of workload accelerated by Alibaba Cloud CDN. Separate types with commas (,). Valid values:
If you do not set this parameter, all service types are queried. | download,web,video |
| CheckDomainShow | boolean | No | Specifies whether to display domain names that are under review, failed the review, or failed to be configured. Valid values:
| false |
| ResourceGroupId | string | No | The ID of the resource group. By default, all IDs are queried. | abcd1234abcd1234 |
| ChangeStartTime | string | No | The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2019-10-10T12:14:55Z |
| ChangeEndTime | string | No | The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note
The end time must be later than the start time.
| 2019-10-10T12:14:58Z |
| Coverage | string | No | The acceleration region. By default, all acceleration regions are queried. Valid values:
| domestic |
| Source | string | No | The information about the origin server. | example.source.com |
| Tag | object [] | No | The list of tags. Maximum number of elements in the list: 20 | |
| Key | string | No | The key of a tag. By default, all tag keys are queried. | key |
| Value | string | No | The value of the tag. By default, all tag values are queried. | value |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "BDA62CE4-3477-439A-B52E-D2D7C829D7C1",
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 2,
"Domains": {
"PageData": [
{
"SslProtocol": "on",
"Sandbox": "true",
"GmtModified": "2015-10-28T11:05:52Z",
"DomainName": "example.com",
"DomainId": 11223344,
"GmtCreated": "2015-10-28T09:32:51Z",
"Description": "filing description",
"Coverage": "domestic",
"ResourceGroupId": "abcd1234abcd1234",
"Cname": "example.com.w.alikunlun.net",
"DomainStatus": "configure_failed",
"CdnType": "download",
"Sources": {
"Source": [
{
"Type": "oss",
"Weight": "15",
"Priority": "20",
"Port": 80,
"Content": "***.oss-cn-hangzhou.aliyuncs.com"
}
]
}
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidPageNumber.ValueNotSupported | The specified value of PageNumber is not supported. | - |
| 400 | InvalidPageSize.ValueNotSupported | The specified value of PageSize is invalid. | - |
| 400 | InvalidDomainStatus.ValueNotSupported | The specified value of DomainStatus is invalid. | - |
| 400 | InvalidDomainName.Malformed | The specified DomainName is invalid. | The specified domain name is invalid. |
| 400 | InvalidDomainSearchType.ValueNotSupported | The specified value of DomainSearchType is invalid. | - |
| 400 | InvalidChangeStartTime.Malformed | The specified ChangeStartTime is invalid. | - |
| 400 | InvalidChangeEndTime.Malformed | The specified ChangeEndTime is invalid. | - |
| 400 | InvalidCdnType.Malformed | The specified CdnType is invalid. | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||
|---|---|---|---|---|---|---|---|---|
| 2023-08-19 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||
| ||||||||
| 2023-06-27 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||
|