全部产品
Search
文档中心

云解析 DNS:DescribeSubDomainRecords - 获取子域名解析记录列表

更新时间:Dec 18, 2024

根据传入参数获取某个固定子域名的所有解析记录列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
alidns:DescribeSubDomainRecordsget
*Domain
acs:alidns::{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
Langstring

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
en
UserClientIpstring

用户端 IP。

192.0.2.0
SubDomainstring

例如参数 SubDomain 为"a.www.example.com"为例:

如果参数 DomainName 为空,则查询域名为 example.com、主机名为”a.www“的解析记录。 如果参数 DomainName 为"www.example.com",则查询域名为"www.example.com"、主机名为"a"的解析记录。 如果参数 DomainName 为"a.www.example.com",则查询域名为"a.www.example.com"、主机名为"@"的解析记录。

a.www.example.com
PageNumberlong

当前页数,起始值为 1,默认为 1

1
PageSizelong

分页查询时设置的每页行数,最大值 100,默认为 20

20
Typestring

解析记录类型。若不传值,则返回子域名对应的全部解析记录类型。

解析类型包括(不区分大小写):A、MX、CNAME、TXT、REDIRECT_URL、FORWORD_URL、NS、AAAA、SRV

MX
Linestring

解析线路。

default
DomainNamestring

域名名称。

example.com

返回参数

名称类型描述示例值
object
TotalCountlong

解析记录总数。

2
PageSizelong

本次查询获取的解析数量。

2
RequestIdstring

请求 ID。

536E9CAD-DB30-4647-AC87-AA5CC38C5382
DomainRecordsarray<object>

解析记录列表。

Recordobject
Statusstring

解析记录状态。

Enable
Typestring

记录类型。

CNAME
Weightinteger

解析记录的权重。

10
Valuestring

记录值。

example.net
TTLlong

生存时间。

600
Linestring

解析线路。

default
RecordIdstring

解析记录 ID。

99******
Prioritylong

MX 记录的优先级。

2
RRstring

主机记录。

www
DomainNamestring

域名名称。

example.com
Lockedboolean

解析记录锁定状态。

false
Remarkstring

备注信息。

test
PageNumberlong

当前页数,起始值为 1,默认为 1

1

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "PageSize": 2,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "DomainRecords": {
    "Record": [
      {
        "Status": "Enable",
        "Type": "CNAME",
        "Weight": 10,
        "Value": "example.net",
        "TTL": 600,
        "Line": "default",
        "RecordId": "99******",
        "Priority": 2,
        "RR": "www",
        "DomainName": "example.com",
        "Locked": false,
        "Remark": "test"
      }
    ]
  },
  "PageNumber": 1
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史