描述
根据传入参数查询该用户的域名列表。
- 查询可以指定页码(PageNumber)和每页的数量(PageSize)来获取域名列表。
- 查询可以指定域名的关键字(KeyWord)来查询含有该关键字的域名列表。
- 域名列表的默认排序方式是按照域名添加的时间从新到旧排序的。
- 查询可以指定域名分组的ID(GroupId),默认为全部分组。
请求参数
返回参数
公共返回参数,详见
公共返回参数
错误码
对于所有接口的通用性错误,请参考
错误代码表。
示例
请求示例
http://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"]}}]}}
阿里云 AI 助理回答
您提到的是使用阿里云DNS服务查询用户域名列表的API接口描述。这个接口允许用户通过指定不同的参数来获取其在阿里云上管理的域名信息。下面是对您提供的信息的一个简要解析和补充说明:
请求参数说明
- Action: 必须参数,固定值为
DescribeDomains
,表示请求的操作是查询域名列表。
- PageNumber: 非必须,当前页码,默认值为1。用于分页查询时指定从哪一页开始。
- PageSize: 非必须,每页显示的域名数量,默认值为20,最大值为100。用来控制每次查询返回的结果数量。
- KeyWord: 非必须,关键字搜索条件。按照“%KeyWord%”模式进行模糊匹配,不区分大小写,可以用来筛选包含特定字符的域名。
- GroupId: 非必须,域名分组ID。如果未提供,则默认查询所有分组下的域名。
返回参数说明
- RequestId: 每次API请求的唯一标识。
- TotalCount: 域名列表的总数,即满足条件的域名总数量。
- PageNumber: 当前查询的页码,与请求中的PageNumber对应。
- PageSize: 本次查询实际返回的域名数量。
- Domains: 实际返回的域名列表,每个域名会以一定的结构(DomainType)展示,具体结构取决于API文档详细说明。
错误码示例
- InvalidDomainGroup.NotExist: 当指定的域名分组ID不存在时,返回此错误,HTTP状态码为400,表示客户端请求有误。
示例请求
您给出的请求示例是一个基本的API调用格式,但完整的请求通常还需要包括AccessKeyId、Signature、SignatureMethod、SignatureNonce、SignatureVersion、Timestamp等认证和签名参数,以确保请求的安全性和有效性。一个典型的完整请求URL可能看起来像这样(注意替换<your-access-key-id>
、<your-access-key-secret>
及计算出的签名等信息):
http://alidns.aliyuncs.com/?Action=DescribeDomains
&Format=json
&Version=2015-01-09
&AccessKeyId=<your-access-key-id>
&SignatureMethod=HMAC-SHA1
&SignatureNonce=<a-random-string>
&SignatureVersion=1.0
&Timestamp=<current-timestamp>
&Signature=<calculated-signature>
请根据阿里云官方文档或SDK的具体要求生成签名和其他安全参数。