调用DescribeDomains根据传入参数查询该用户的域名列表。
1. 可以指定页码(PageNumber)和每页的数量(PageSize)来获取域名列表。
2. 可以指定域名的关键字(KeyWord)来查询含有该关键字的域名列表。
3. 域名列表的默认排序方式是按照域名添加的时间从新到旧排序的。
4. 可以指定域名分组的ID(GroupId),全部域名代表所有域名、默认分组代表未设置分组的域名。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDomains | 系统规定参数。取值:DescribeDomains。 |
Lang | String | 否 | en | 用户语言。 |
KeyWord | String | 否 | com | 关键字,按照“%KeyWord%”模式搜索,不区分大小写。 |
GroupId | String | 否 | 2223 | 指域名分组ID。如不填或传空字符,将在全部域名下查询。如传defaultGroup,将在默认分组下查询。 |
PageNumber | Long | 否 | 1 | 当前页数,起始值为1,默认为1。 |
PageSize | Long | 否 | 20 | 分页查询时设置的每页行数,最大值100,默认为20。 |
SearchMode | String | 否 | LIKE | 搜索模式。取值:
|
ResourceGroupId | String | 否 | rg-resourcegroupid01 | 资源组ID。 |
Starmark | Boolean | 否 | true | 是否查询域名星标。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Domains | Array of Domain | 本次获取的域名列表。 |
|
Domain | |||
Remark | String | remark | 备注。 |
CreateTime | String | 2019-01-30T05:25Z | 创建时间 |
RecordCount | Long | 100 | 域名含有的解析记录条数。 |
Tags | Array of Tag | ||
Tag | |||
Key | String | 测试标签 | 标签键 |
Value | String | 测试标签值 | 标签值 |
InstanceId | String | i-7bg | 云解析产品ID。 |
DomainName | String | abc.com | 域名名称。 |
DomainId | String | 00efd71a-770e-4255-b54e-6fe5659baffe | 域名ID。 |
AliDomain | Boolean | true | 是否为阿里云万网域名。 |
GroupId | String | 2223 | 域名分组ID。 |
GroupName | String | mygroup | 域名分组名称。 |
ResourceGroupId | String | rg-acf | 所属资源组ID |
InstanceEndTime | String | 2020-03-14T16:00Z | 实例的到期时间。 |
InstanceExpired | Boolean | false | 实例是否过期。 |
VersionName | String | 企业标准版 | 云解析产品名称。 |
DnsServers | Array of String | {"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]} | 域名在解析系统中的DNS列表。 |
VersionCode | String | version_enterprise_basic | 云解析版本Code。 |
PunyCode | String | abc.com | 中文域名的punycode码,英文域名返回为空。 |
RegistrantEmail | String | test@example.com | 注册人邮箱。 |
CreateTimestamp | Long | 1660546144000 | 创建时间戳 |
Starmark | Boolean | true | 是否收藏至常用域名列表 |
TotalCount | Long | 2 | 域名列表总数。 |
PageSize | Long | 2 | 本次查询获取的域名数量。 |
RequestId | String | 68386699-8B9E-4D5B-BC4C-75A28F6C2A00 | 请求ID。 |
PageNumber | Long | 1 | 当前页码。 |
示例
请求示例
正常返回示例
JSON
格式
HTTP/1.1 200 OK
错误码
访问错误中心查看更多错误码。