根据传入参数获取指定主域名的所有解析记录列表。
接口说明
- 查询可以指定域名(DomainName)、页码(PageNumber)和每页的数量(PageSize)来获取域名的解析列表。
- 查询可以指定解析记录的主机记录关键字(RRKeyWord)、解析类型关键字(TypeKeyWord)或者记录值的关键字(ValueKeyWord)来查询含有该关键字的解析列表。
- 解析列表的默认排序方式是按照解析添加的时间从新到旧排序的。
- 可以指定域名分组的 ID(GroupId),全部域名代表所有域名、默认分组代表未设置分组的域名。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alidns:DescribeDomainRecords | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Lang | string | 否 | 语言。 | en |
DomainName | string | 是 | 域名名称。 | example.com |
PageNumber | long | 否 | 当前页数,起始值为 1,默认为 1。 | 1 |
PageSize | long | 否 | 分页查询时设置的每页行数,最大值 500,默认为 20。 | 20 |
KeyWord | string | 否 | 关键字。 | test |
RRKeyWord | string | 否 | 主机记录的关键字,按照 RRKeyWord(前后模糊匹配)模式搜索,不区分大小写。 | www |
TypeKeyWord | string | 否 | 解析类型的关键字,按照全匹配搜索,不区分大小写。 | MX |
ValueKeyWord | string | 否 | 记录值的关键字,按照 ValueKeyWord(前后模糊匹配)模式搜索,不区分大小写。 | com |
OrderBy | string | 否 | 排序方式。按照解析添加的时间从新到旧排序。 | default |
Direction | string | 否 | 排序方向。取值范围:DESC、ASC。默认为:DESC。 | DESC |
SearchMode | string | 否 | 搜索模式,取值:LIKE/EXACT/ADVANCED。
| LIKE |
GroupId | long | 否 | 指域名分组 ID
| 2223 |
Type | string | 否 | 解析记录类型,参见: | A |
Line | string | 否 | cn_mobile_anhui | |
Status | string | 否 | 解析记录状态,取值:Enable/Disable。 | Enable |
返回参数
示例
正常返回示例
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-20 | OpenAPI 返回结构发生变更 | 查看变更详情 |