根据传入参数查询该用户的域名列表。
接口说明
- 可以指定页码（PageNumber）和每页的数量（PageSize）来获取域名列表。
- 可以指定域名的关键字（KeyWord）来查询含有该关键字的域名列表。
- 域名列表的默认排序方式是按照域名添加的时间从新到旧排序的。
- 可以指定域名分组的 ID（GroupId），全部域名代表所有域名、默认分组代表未设置分组的域名。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| alidns:DescribeDomains | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Lang | string | 否 | 语言。 | en |
| KeyWord | string | 否 | 关键字，按照“%KeyWord%”模式搜索，不区分大小写。 | com |
| GroupId | string | 否 | 指域名分组 ID。如不填或传空字符，将在全部域名下查询。如传 defaultGroup，将在默认分组下查询。 | 2223 |
| PageNumber | long | 否 | 当前页数，起始值为 1，默认为 1。 | 1 |
| PageSize | long | 否 | 分页查询时设置的每页行数，最大值 100，默认为 20。 | 20 |
| SearchMode | string | 否 | 搜索模式。取值：
| LIKE |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-resourcegroupid01 |
| Starmark | boolean | 否 | 是否查询域名星标。 | true |
返回参数
示例
正常返回示例
JSON格式
{
"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": "OPEN"
}
]
},
"TotalCount": 2,
"PageSize": 2,
"RequestId": "68386699-8B9E-4D5B-BC4C-75A28F6C2A00",
"PageNumber": 1
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-01-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |