DescribeDomains - 获取域名列表 - 云解析 DNS

根据传入参数查询该用户的域名列表。

接口说明

可以指定页码（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：模糊搜索 EXACT：精确搜索	LIKE
ResourceGroupId	string	否	资源组 ID。	rg-resourcegroupid01
Starmark	boolean	否	是否查询域名星标。	true

返回参数

名称	类型	描述	示例值
	object
Domains	array<object>	本次获取的域名列表。
Domain	object	本次获取的域名列表。
Remark	string	备注。	remark
CreateTime	string	域名添加时间。	2019-01-30T05:25Z
RecordCount	long	域名含有的解析记录条数。	100
Tags	array<object>	标签键值对数组。
Tag	object
Key	string	标签键。	测试标签
Value	string	标签值。	测试标签值
InstanceId	string	云解析产品 ID。	i-7bg
DomainName	string	域名名称。	abc.com
DomainId	string	域名 ID。	00efd71a-770e-4255-b54e-6fe5659baffe
AliDomain	boolean	是否为阿里云万网域名。	true
GroupId	string	域名分组 ID。	2223
GroupName	string	域名分组名称。	mygroup
ResourceGroupId	string	所属资源组 ID。	rg-acf
InstanceEndTime	string	实例的到期时间。	2020-03-14T16:00Z
InstanceExpired	boolean	实例是否过期。	false
VersionName	string	云解析产品名称。	企业标准版
DnsServers	array	云解析系统分配的 DNS 服务器名称列表。
DnsServer	string	云解析系统分配的 DNS 服务器名称。	{"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]}
VersionCode	string	云解析版本 Code。	version_enterprise_basic
PunyCode	string	中文域名的 punycode 码，英文域名返回为空。	abc.com
RegistrantEmail	string	注册人邮箱。	test@example.com
CreateTimestamp	long	添加时间（时间戳）。	1660546144000
Starmark	boolean	是否收藏至常用域名列表。	true
DomainLoggingSwitchStatus	string	域名 DNS 流量分析开启状态： OPEN：开启 CLOSE：关闭	OPEN
TotalCount	long	域名列表总数。	2
PageSize	long	分页查询时设置的每页行数，最大值 100，默认为 20。	2
RequestId	string	唯一请求识别码。	68386699-8B9E-4D5B-BC4C-75A28F6C2A00
PageNumber	long	当前页数，起始值为 1，默认为 1。	1

示例

正常返回示例

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 返回结构发生变更	查看变更详情