The information about all IPA-accelerated domain names within your Alibaba Cloud account is queried.
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:DescribeDcdnIpaUserDomains | List |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
PageSize | integer | No | The number of domain names to return on each page. Default value: 20. Maximum value: 500. Valid values: an integer between 1 and 500. | 5 |
PageNumber | integer | No | The page number of the returned page. Valid values: 1 to 100000. Default value: 1. | 1 |
DomainName | string | No | The domain name that is used as a keyword to filter domain names. Fuzzy match is supported. | 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:
| 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. | ResourceGroupId |
FuncId | string | No | The ID of the feature. For example, a value of 7 specifies the feature of configuring an expiration rule for a specific directory. For more information about feature IDs, see Parameters for configuring features for domain names. | 7 |
FuncFilter | string | No | The status of the feature.
| config |
Tag | object [] | No | The tags of the command. | |
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": 20,
"TotalCount": 1,
"Domains": {
"PageData": [
{
"GmtCreated": "2015-10-28T09:32:51Z",
"Description": "audit failed",
"SSLProtocol": "on",
"ResourceGroupId": "abcd1234abcd****",
"Sandbox": "normal",
"DomainStatus": "online",
"Cname": "example.com.*.com",
"GmtModified": "2015-10-28T11:05:52Z",
"DomainName": "example.com",
"Sources": {
"Source": [
{
"Type": "OSS Domain\n",
"Weight": "20",
"Priority": "20",
"Port": 80,
"Content": "*.aliyuncs.com"
}
]
}
}
]
}
}
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. |
For a list of error codes, visit the Service error codes.