Queries the domain names for CDN within your Alibaba Cloud account. You can filter domain names by name or by state. When you filter domain names by name, a fuzzy match is supported.
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 |
---|---|---|---|---|
vod:DescribeVodUserDomains | List |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
PageSize | integer | No | The number of entries to return on each page. Default value: 20. Maximum value: 50. Valid values: integers in the range of 1 to 50. | 20 |
PageNumber | integer | No | The number of the page to return. | 1 |
DomainName | string | No | The domain name. The value of this parameter is used as a filter condition for a fuzzy match. | example.aliyundoc.com |
DomainStatus | string | No | The status of the domain name. The value of this parameter is used as a condition to filter domain names. Value values:
| online |
DomainSearchType | string | No | The search method. Valid values:
| fuzzy_match |
Tag | object [] | No | Tag. | |
Key | string | No | The key of tag N. Valid values of N: 1 to 20. If you do not specify this parameter, all tag keys are queried. | key |
Value | string | No | The value of tag N. Valid values of N: 1 to 20. If you do not specify this parameter, all tag values are queried. | value |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "E4EBD2BF-5EB0-4476-****-9D94E1B15267",
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 2,
"Domains": {
"PageData": [
{
"GmtCreated": "2017-08-29T08:40:53Z",
"SslProtocol": "on",
"Description": "Zhejiang ICP Filing No. ****",
"Sandbox": "normal",
"Cname": "learn.developer.aliyundoc.com",
"DomainStatus": "online",
"GmtModified": "2017-12-29T09:24:12Z",
"DomainName": "example.aliyundoc.com",
"Sources": {
"Source": [
{
"Type": "oss",
"Priority": "5",
"Port": 80,
"Content": "192.168.0.1"
}
]
}
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||
---|---|---|---|---|---|---|
2022-10-27 | The error codes of the API operation change. | |||||
|
Common errors
The following table describes the common errors that this operation can return.
Error code | Error message | HTTP status code | Description |
---|---|---|---|
InvalidPageNumber.ValueNotSupported | The specified value of parameter PageNumber is not supported. | 400 | The error message returned because the value of the PageNumber parameter is invalid. |
InvalidPageSize.ValueNotSupported | The specified value of parameter PageSize is not supported. | 400 | The error message returned because the value of the PageSize parameter is invalid. |
InvalidDomainName.Malformed | The specific value of parameter DomainName is malformed. | 400 | The error message returned because the value of the DomainName parameter is invalid. |
InvalidDomainStatus.ValueNotSupported | The specified value of parameter DomainStatus is not supported. | 400 | The error message returned because the value of the DomainStatus parameter is invalid. |
InvalidDomainSearchType.ValueNotSupported | The specified value of parameter DomainSearchType is not supported. | 400 | The error message returned because the value of the DomainSearchType parameter is invalid. |