Calls the DescribeDomains operation to query domain names of a user based on input parameters.
Operation description
- You can specify the PageNumber and PageSize parameters to query domain names.
- You can specify the KeyWord parameter to query domain names that contain the specified keyword.
- By default, the domain names in a list are sorted in descending order of the time they were added.
- You can specify the GroupId parameter. If you do not specify this parameter, all domain names are queried by default.
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 |
|---|---|---|---|---|
| alidns:DescribeDomains | READ |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Lang | string | No | The language type. | en |
| KeyWord | string | No | The keyword for searches in "%KeyWord%" mode. The value is not case-sensitive. | com |
| GroupId | string | No | The ID of the domain name group. If you do not specify this parameter, all domain names are queried by default. | 2223 |
| PageNumber | long | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
| PageSize | long | No | The number of entries to return on each page. Maximum value: 100. Default value: 20. | 20 |
| SearchMode | string | No | The search mode. Valid values:
| LIKE |
| ResourceGroupId | string | No | The ID of the resource group. | rg-resourcegroupid01 |
| Starmark | boolean | No | Specifies whether to query the starmark of the domain name. | true |
Response parameters
Examples
Sample success responses
JSONformat
{
"Domains": {
"Domain": [
{
"Remark": "remark",
"CreateTime": "2019-01-30T05:25Z",
"RecordCount": 100,
"Tags": {
"Tag": [
{
"Key": "",
"Value": ""
}
]
},
"InstanceId": "i-7bg",
"DomainName": "abc.com",
"DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
"AliDomain": true,
"GroupId": "2223",
"GroupName": "mygroup",
"ResourceGroupId": "rg-acf",
"InstanceEndTime": "2020-03-14T16:00Z",
"InstanceExpired": false,
"VersionName": "",
"DnsServers": {
"DnsServer": [
"{\"DnsServer\": [\"ns1.alidns.com\",\"ns2.alidns.com\"]}"
]
},
"VersionCode": "version_enterprise_basic",
"PunyCode": "abc.com",
"RegistrantEmail": "test@example.com",
"CreateTimestamp": 1660546144000,
"Starmark": true,
"DomainLoggingSwitchStatus": ""
}
]
},
"TotalCount": 2,
"PageSize": 2,
"RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
"PageNumber": 1
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||
|---|---|---|---|---|
| 2024-01-17 | The response structure of the API has changed | see changesets | ||
|