Queries the accelerated domain names that belong to your Alibaba Cloud account. You can filter domains by name or by status. Fuzzy match is supported when you filter domains by name.
Operation description
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 Resources
is 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 |
---|---|---|---|---|
dcdn:DescribeDcdnUserDomains | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
PageSize | integer | No | The number of entries to return on each page. Default value: 20. Valid values: 1 to 500. | 20 |
PageNumber | integer | No | The number of returned pages. Valid values: 1 to 100000. | 1 |
DomainName | string | No | The accelerated domain names. If you do not set this parameter, configurations of all domain names that match the conditions are returned. | example.com |
DomainStatus | string | No | The status of the domain name. Valid values:
| online |
DomainSearchType | string | No | The search method. Default value: full_match. 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 |
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. | rg-acfmv6jutt** |
ChangeStartTime | string | No | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0. | 2018-05-10T12:00:00Z |
ChangeEndTime | string | No | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC+0. Note
The end time must be later than the start time.
| 2018-05-10T14:00:00Z |
Coverage | string | No | The acceleration region. By default, all acceleration regions are queried.
| domestic |
Tag | object [] | No | The list of tags. | |
Key | string | No | The tag key. Valid values of N: 1 to 20. You can call the TagDcdnResources operation to set a tag for a domain name. | 1 |
Value | string | No | The tag value. Valid values of N: 1 to 20. | 1 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "AA75AADB-5E25-4970-B480-EAA1F5658483",
"PageNumber": 1,
"PageSize": 12,
"TotalCount": 12,
"Domains": {
"PageData": [
{
"GmtCreated": "2015-10-28T11:05:50Z",
"Description": "audit failed",
"SSLProtocol": "on",
"ResourceGroupId": "rg-acfmv6jutt**",
"Sandbox": "normal",
"DomainStatus": "online",
"Cname": "test.aliyun.com.w.alikunlun.com",
"GmtModified": "2015-10-28T09:31:59Z",
"DomainName": "www.example.com",
"DomainId": 11223344,
"Sources": {
"Source": [
{
"Type": "oss",
"Weight": "20",
"Priority": "20",
"Port": 80,
"Content": "example.com"
}
]
},
"Scene": "apiscene"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidPageNumber.ValueNotSupported | The specified value of PageNumber is not supported. | The PageNumber parameter is set to an invalid value. Specify a valid value and try again. |
400 | InvalidPageSize.ValueNotSupported | The specified value of PageSize is invalid. | The PageSize parameter is set to an invalid. Specify a valid value and try again. |
400 | InvalidDomainStatus.ValueNotSupported | The specified value of DomainStatus is invalid. | The DomainStatus parameter is set to an invalid value. Specify a valid value and try again. |
400 | InvalidDomainName.Malformed | The specified DomainName is invalid. | The specified domain name is invalid. |
400 | InvalidDomainSearchType.ValueNotSupported | The specified value of DomainSearchType is invalid. | The DomainSearchType parameter is set to an invalid value. Specify a valid value and try again. |
400 | InvalidChangeStartTime.Malformed | The specified ChangeStartTime is invalid. | The update start time is invalid. |
400 | InvalidChangeEndTime.Malformed | The specified ChangeEndTime is invalid. | The update end time is invalid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-08-29 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||
| ||||||||||||
2023-08-02 | The Error code has changed. The response structure of the API has changed | see changesets | ||||||||||
|