文档

DescribeDomainRecords - 获取解析记录列表

更新时间:

根据传入参数获取指定主域名的所有解析记录列表。

接口说明

  • 查询可以指定域名(DomainName)、页码(PageNumber)和每页的数量(PageSize)来获取域名的解析列表。
  • 查询可以指定解析记录的主机记录关键字(RRKeyWord)、解析类型关键字(TypeKeyWord)或者记录值的关键字(ValueKeyWord)来查询含有该关键字的解析列表。
  • 解析列表的默认排序方式是按照解析添加的时间从新到旧排序的。
  • 可以指定域名分组的 ID(GroupId),全部域名代表所有域名、默认分组代表未设置分组的域名。

调试

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

授权信息

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

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

请求参数

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

语言。

en
DomainNamestring

域名名称。

example.com
PageNumberlong

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

1
PageSizelong

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

20
KeyWordstring

关键字。

test
RRKeyWordstring

主机记录的关键字,按照 RRKeyWord(前后模糊匹配)模式搜索,不区分大小写。

www
TypeKeyWordstring

解析类型的关键字,按照全匹配搜索,不区分大小写。

MX
ValueKeyWordstring

记录值的关键字,按照 ValueKeyWord(前后模糊匹配)模式搜索,不区分大小写。

com
OrderBystring

排序方式。按照解析添加的时间从新到旧排序。

default
Directionstring

排序方向。取值范围:DESC、ASC。默认为:DESC。

DESC
SearchModestring

搜索模式,取值:LIKE/EXACT/ADVANCED。

  • 填入 LIKE 或 EXACT 时,请使用 KeyWord 参数。(传入 RRKeyWord、TypeKeyWord、ValueKeyWord、Type、Line、Status 参数无效)
  • 填入 ADVANCED 时,请使用 RRKeyWord、TypeKeyWord、ValueKeyWord、Type、Line、Status
  • 不传值:
    • keyWord 传值,搜索模式取”LIKE“值。
    • keyWord 不传值,RRKeyWord 和 ValueKeyWord 支持模糊查询,TypeKeyWord 和 Type、Line、Status 支持精确查询。
LIKE
GroupIdlong

指域名分组 ID

  • 如不传 GroupId,则在全部域名下查询。

  • 如 GroupId 为 0,则返回空数据。

  • 如 GroupId 为-1,则在默认分组(指未设置分组的域名)下查询。

  • 如 GroupId 为-2,则在全部域名下查询。

  • 如 GroupId 不符合上述条件,则按 GroupId 查询并返回结果。

2223
Typestring

解析记录类型,参见:

解析记录类型格式

A
Linestring

解析线路,默认为 default

参见: 解析线路枚举

cn_mobile_anhui
Statusstring

解析记录状态,取值:Enable/Disable

Enable

返回参数

名称类型描述示例值
object
TotalCountlong

解析记录总数。

2
PageSizelong

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

20
RequestIdstring

请求 ID。

536E9CAD-DB30-4647-AC87-AA5CC38C5382
DomainRecordsobject []

解析记录列表。

Statusstring

当前的解析记录状态。

Enable
Typestring

记录类型。

MX
Remarkstring

备注。

备注
TTLlong

缓存时间设置。单位:秒。

600
RecordIdstring

解析记录 ID。

9999985
Prioritylong

mx 记录的优先级。

5
RRstring

主机记录。

www
DomainNamestring

域名名称。

example.com
Weightinteger

负载均衡权重。

2
Valuestring

记录值。

mail1.hichina.com
Linestring

解析线路。

default
Lockedboolean

当前解析记录锁定状态。

false
CreateTimestamplong

创建时间(时间戳)。

1666501957000
UpdateTimestamplong

更新时间(时间戳)。

1676872961000
PageNumberlong

当前页码。

1

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "PageSize": 20,
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "DomainRecords": {
    "Record": [
      {
        "Status": "Enable",
        "Type": "MX",
        "Remark": "备注",
        "TTL": 600,
        "RecordId": "9999985",
        "Priority": 5,
        "RR": "www",
        "DomainName": "example.com",
        "Weight": 2,
        "Value": "mail1.hichina.com",
        "Line": "default",
        "Locked": false,
        "CreateTimestamp": 1666501957000,
        "UpdateTimestamp": 1676872961000
      }
    ]
  },
  "PageNumber": 1
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-09-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈