Queries a list of domain names.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
AccessKeyId | String | No | xxxx |
The AccessKey ID provided to you by Alibaba Cloud. |
Action | String | No | QueryDomainByParam |
The operation that you want to perform. Set the value to QueryDomainByParam. |
KeyWord | String | No | abc.com |
The domain name. It must be 1 to 50 characters in length and can contain digits, letters, periods (.), and hyphens (-). |
PageNo | Integer | No | 1 |
The number of the page to return. Default value: 1. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. Default value: 10. |
Status | Integer | No | 0 |
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
PageNumber | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 50 |
The number of entries returned per page. |
RequestId | String | 8C90CCD3-627C-4F87-AD8C-2F03146071EB |
The ID of the request. |
TotalCount | Integer | 2 |
The total number of domain names. |
data |
The information about domain names. |
||
domain |
The information about domain names. |
||
CnameAuthStatus | String | 0 |
Indicates whether your ownership of the domain is verified. |
ConfirmStatus | String | 0 |
Indicates whether the CNAME record is successfully verified. Valid values: 0 and 1. 0: indicates the verification is successful. 1: indicates that the verification fails. |
CreateTime | String | 2019-09-29T13:28Z |
The time when the DNS record was created. |
DomainId | String | 158923 |
The ID of the domain name. |
DomainName | String | vmeixme.com |
The domain name. |
DomainStatus | String | 0 |
The status of the domain name. Valid values: 0 to 4.
|
IcpStatus | String | 1 |
The status of ICP filing. Valid values: 0 and 1.
|
MxAuthStatus | String | 0 |
Indicates whether the MX record is successfully verified. Valid values: 0 and 1. 0: indicates the verification is successful. 1: indicates that the verification fails. |
SpfAuthStatus | String | 0 |
Indicates whether the SPF record is successfully verified. Valid values: 0 and 1. 0: indicates the verification is successful. 1: indicates that the verification fails. |
UtcCreateTime | Long | 1569734892 |
The time when the DNS record was created. The time is displayed in UTC. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=QueryDomainByParam
&<Common request parameters>
Sample success responses
JSON
format
{
"PageNumber":1,
"TotalCount":2,
"PageSize":50,
"RequestId":"8C90CCD3-627C-4F87-AD8C-2F03146071EB",
"data":{
"domain":[
{
"MxAuthStatus":1,
"UtcCreateTime":1569734892,
"IcpStatus":1,
"SpfAuthStatus":1,
"DomainStatus":1,
"CreateTime":"2019-09-29T13:28Z",
"ConfirmStatus":1,
"DomainName":"vmeixme.com",
"DomainId":158923,
"CnameAuthStatus":1,
"DomainRecord":"6bd86901b9fe4618a046"
},
{
"MxAuthStatus":1,
"UtcCreateTime":1569731275,
"IcpStatus":1,
"SpfAuthStatus":1,
"DomainStatus":1,
"CreateTime":"2019-09-29T12:27Z",
"ConfirmStatus":1,
"DomainName":"abc.com",
"DomainId":158910,
"CnameAuthStatus":1,
"DomainRecord":"0c40d5f125af4e42892a"
}
]
}
}
Error codes
For a list of error codes, visit the API Error Center.