653
阿里云
获取域名列表__域名管理接口_API文档_云解析-阿里云
描述
根据传入参数查询该用户的域名列表。
- 查询可以指定页码(PageNumber)和每页的数量(PageSize)来获取域名列表。
- 查询可以指定域名的关键字(KeyWord)来查询含有该关键字的域名列表。
- 域名列表的默认排序方式是按照域名添加的时间从新到旧排序的。
- 查询可以指定域名分组的ID(GroupId),默认为全部分组。
请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Action | String | 是 | 操作接口名,系统规定参数,取值:DescribeDomains |
PageNumber | Long | 否 | 当前页数,起始值为1,默认为1 |
PageSize | Long | 否 | 分页查询时设置的每页行数,最大值100,默认为20 |
KeyWord | String | 否 | 关键字,按照”%KeyWord%”模式搜索,不区分大小写 |
GroupId | String | 否 | 域名分组ID,如果不填写则默认为全部分组 |
返回参数
公共返回参数,详见公共返回参数
名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求识别码 |
TotalCount | Long | 域名列表总数 |
PageNumber | Long | 当前页码 |
PageSize | Long | 本次查询获取的域名数量 |
Domains | DomainType | 本次获取的域名列表 |
错误码
对于所有接口的通用性错误,请参考错误代码表。
错误代码 | 描述 | HTTP 状态码 | 语义 |
---|---|---|---|
InvalidDomainGroup.NotExist | The domain group name is not exist. | 400 | 域名分组不存在 |
示例
请求示例
https://alidns.aliyuncs.com/?Action=DescribeDomains
&PageNumber=1
&PageSize=20
&KeyWord=com
&GroupId=2223
&<公共请求参数>
返回示例
XML格式
<DescribeDomainsResponse>
<RequestId>6393C3A8-B611-42F2-AFA6-F080FC45D5D0</RequestId>
<TotalCount>2</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<Domains>
<Domain>
<DomainId>00efd71a-770e-4255-b54e-6fe5659baffe</DomainId>
<DomainName>abc.com</DomainName>
<AliDomain>true</AliDomain>
<GroupId>2223</GroupId>
<PunyCode>abc.com</PunyCode>
<InstanceId>i-7bg</InstanceId>
<VersionCode>version1</VersionCode>
<DnsServers>
<DnsServer>dns1.hichina.com</DnsServer>
<DnsServer>dns2.hichina.com</DnsServer>
</DnsServers>
</Domain>
<Domain>
<DomainId>00efd71a-770e-4255-b54e-6fe5659baffe</DomainId>
<DomainName>实例.com</DomainName>
<AliDomain>false</AliDomain>
<GroupId>2223</GroupId>
<PunyCode>xn--fsq270a.com</PunyCode>
<InstanceId>i-7bk</InstanceId>
<VersionCode>version2</VersionCode>
<DnsServers>
<DnsServer>dns1.hichina.com</DnsServer>
<DnsServer>dns2.hichina.com</DnsServer>
</DnsServers>
</Domain>
</Domains>
</DescribeDomainsResponse>
JSON示例
{
"RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
"TotalCount": 2,
"PageNumber": 1,
"PageSize": 2,
"Domains": {
"Domain": [
{
"DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
"DomainName": "abc.com",
"AliDomain": "true",
"GroupId": "2223",
"PunyCode": "abc.com",
"InstanceId": "i-7bg",
"VersionCode": "version1",
"DnsServers": {
"DnsServer": [
"ns1.alidns.com",
"ns2.alidns.com"
]
}
},
{
"DomainId": "00efd71a-770e-4255-b54e-6fe5659baffe",
"DomainName": "实例.com",
"AliDomain": "false",
"GroupId": "2223",
"PunyCode": "xn--fsq270a.com",
"InstanceId": "i-7bk",
"VersionCode": "version2",
"DnsServers": {
"DnsServer": [
"ns1.alidns.com",
"ns2.alidns.com"
]
}
}
]
}
}
最后更新:2016-11-23 17:16:06
上一篇:
网站监控__产品使用手册_云解析-阿里云
下一篇:
获取域名信息__域名管理接口_API文档_云解析-阿里云
常见错误说明__附录_大数据计算服务-阿里云
发送短信接口__API使用手册_短信服务-阿里云
接口文档__Android_安全组件教程_移动安全-阿里云
运营商错误码(联通)__常见问题_短信服务-阿里云
设置短信模板__使用手册_短信服务-阿里云
OSS 权限问题及排查__常见错误及排除_最佳实践_对象存储 OSS-阿里云
消息通知__操作指南_批量计算-阿里云
设备端快速接入(MQTT)__快速开始_阿里云物联网套件-阿里云
查询API调用流量数据__API管理相关接口_API_API 网关-阿里云
使用STS访问__JavaScript-SDK_SDK 参考_对象存储 OSS-阿里云