查询站点下解析记录列表,包括记录值、优先级、认证配置等。支持根据记录名称、记录类型等条件进行过滤。
接口说明
边缘容器、边缘函数与四层加速对应的 DNS 解析记录,将不会在此 API 中返回。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
esa:ListRecords |
get |
*Site
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SiteId |
integer |
是 |
站点 ID,可通过调用 ListSites 接口获取。 |
1234567890123 |
| RecordName |
string |
否 |
记录名称。用于查询的过滤条件。 |
www.example.com |
| RecordMatchType |
string |
否 |
记录名称的搜索匹配模式。默认为精确匹配,取值:
|
fuzzy |
| PageNumber |
integer |
否 |
页码。默认值:1。 |
1 |
| PageSize |
integer |
否 |
分页大小。默认值:500。 |
10 |
| SourceType |
string |
否 |
记录的源站类型,用于查询的过滤条件(仅 CNAME 记录可以通过该字段筛选),取值:
|
OSS |
| BizName |
string |
否 |
记录加速时的业务场景,用于查询的过滤条件,取值:
|
web |
| Proxied |
boolean |
否 |
记录是否开启代理加速,用于查询的过滤条件。取值:
|
true |
| Type |
string |
否 |
记录的 DNS 记录类型,用于查询的过滤条件。 |
CNAME |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
15C66C7B-671A-4297-9187-2C4477247A74 |
| PageNumber |
integer |
当前页码。 |
1 |
| PageSize |
integer |
每页显示的记录条数。 |
10 |
| TotalCount |
integer |
记录总条数。 |
20 |
| Records |
array<object> |
记录的 DNS 信息,详情请参考说明文档。 |
|
|
array<object> |
单个记录信息。 |
||
| BizName |
string |
记录加速时的业务场景,取值:
|
web |
| Data |
object |
记录的具体 DNS 信息。不同类型记录包含不同的信息。 |
{"value":"1.1.1.1"} |
| Value |
string |
记录值或部分内容。A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI 记录含有该参数。在不同类型的记录中,分别表示不同的含义:
|
CNAME |
| Priority |
integer |
记录的优先级,范围为 0~65535。数值越小,优先级越高。MX、SRV、URI 记录独有。 |
0 |
| Flag |
integer |
记录的标志位。CAA 记录的 Flag 指示其优先级和处理方式,取值范围为0~255。CAA 记录独有。 |
128 |
| Tags |
object |
||
| Weight |
integer |
记录的权重,范围为0~65535。SRV、URI 记录独有。 |
0 |
| Port |
integer |
记录的端口,范围为0~65535。SRV 记录独有。 |
80 |
| Type |
integer |
记录的证书类型(在 CERT 记录中),或公钥类型(在 SSHFP 记录中)。 |
0 |
| KeyTag |
integer |
记录的公钥标识,范围为0~65535。CERT 记录独有。 |
0 |
| Algorithm |
integer |
记录所采用的加密算法,范围为0~255。CERT、SSHFP 记录独有。 |
0 |
| Certificate |
string |
记录的公钥证书信息。CERT、SMIMEA 和 TLSA 记录独有。 |
dGVzdGFkYWxrcw== |
| Usage |
integer |
记录的用途标识,范围为0~255。SMIMEA 和 TLSA 记录独有。 |
0 |
| Selector |
integer |
记录所使用的证书或公钥的类型,范围为0~255。SMIMEA 和 TLSA 记录独有。 |
0 |
| MatchingType |
integer |
记录用于匹配或验证证书的算法策略,范围为0~255。SMIMEA 和 TLSA 记录独有。 |
0 |
| Fingerprint |
string |
记录的公钥指纹值。SSHFP 记录独有。 |
abcdef1234567890 |
| Tag |
string |
记录的标签。CAA 记录的 Tag 表示其具体类型和用途。CAA 记录独有。 |
issue |
| CreateTime |
string |
记录的创建时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2023-12-24T02:01:11Z |
| UpdateTime |
string |
记录的更新时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2023-06-07T10:02:59Z |
| Proxied |
boolean |
记录是否开启代理加速。取值:
|
true |
| RecordId |
integer |
记录 ID。 |
1234567890123 |
| RecordSourceType |
string |
CNAME 记录的源站类型。添加 CNAME 记录时,需要填写此参数。取值:
该参数不传或传空时,则默认为 Domain,即普通域名源站类型。 |
OSS |
| RecordName |
string |
记录名称。 |
a.example.com |
| RecordType |
string |
记录的 DNS 类型。如A/AAAA、CNAME、TXT等。 |
A/AAAA |
| SiteId |
integer |
记录所属站点的 ID。 |
1234567890123 |
| SiteName |
string |
记录所属站点的名称。 |
example.com |
| Ttl |
integer |
记录的过期时间,单位秒。当取值为 1 时,表示记录的过期时间为自动。 |
30 |
| RecordCname |
string |
记录的 CNAME。当站点的接入方式为 CNAME 接入时,需要为记录配置的 CNAME 值。 |
a.example.com.cnamezone.com |
| Comment |
string |
记录的备注。 |
this is a remark. |
| AuthConf |
object |
CNAME 记录的源站鉴权信息。 |
|
| AuthType |
string |
源站鉴权类型,不同的源站类型,支持的鉴权类型不同,源站类型是指本接口中的 SourceType 参数,现在源站类型为 OSS 和 S3 时,需要填写源站鉴权类型,可选值:
|
private |
| AccessKey |
string |
源站所属账号的 AccessKey,当源站类型为 OSS 且源站鉴权类型为私有跨账号读,或者源站类型为 S3 且源站鉴权类型为私有读时有该参数。 |
u0Nkg5gBK***QF5wvKMM504JUHt |
| SecretKey |
string |
源站所属账号的 SecretKey,当源站类型为 OSS 且源站鉴权类型为私有跨账号读,或者源站类型为 S3 且源站鉴权类型为私有读时有该参数。 |
VIxuvJSA2S03f***kp208dy5w7 |
| Version |
string |
签名算法版本,当源站类型为 S3 且源站鉴权类型为私有读时有该参数,支持以下两种:
不传时,默认为 v4。 |
v4 |
| Region |
string |
源站所属区域,当源站类型为 S3 时有该参数,源站所属的区域需要在 S3 的官方网站上获取。 |
us-east-1 |
| HostPolicy |
string |
回源 HOST 策略,记录类型为 CNAME 时生效,设置回源时带 HOST 的策略,有两种模式:
|
follow_origin_domain |
示例
正常返回示例
JSON格式
{
"RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 20,
"Records": [
{
"BizName": "web",
"Data": {
"Value": "CNAME",
"Priority": 0,
"Flag": 128,
"Tags": {
"test": "test",
"test2": 1
},
"Weight": 0,
"Port": 80,
"Type": 0,
"KeyTag": 0,
"Algorithm": 0,
"Certificate": "dGVzdGFkYWxrcw==",
"Usage": 0,
"Selector": 0,
"MatchingType": 0,
"Fingerprint": "abcdef1234567890",
"Tag": "issue"
},
"CreateTime": "2023-12-24T02:01:11Z",
"UpdateTime": "2023-06-07T10:02:59Z",
"Proxied": true,
"RecordId": 1234567890123,
"RecordSourceType": "OSS",
"RecordName": "a.example.com",
"RecordType": "A/AAAA",
"SiteId": 1234567890123,
"SiteName": "example.com",
"Ttl": 30,
"RecordCname": "a.example.com.cnamezone.com",
"Comment": "this is a remark.",
"AuthConf": {
"AuthType": "private",
"AccessKey": "u0Nkg5gBK***QF5wvKMM504JUHt",
"SecretKey": "VIxuvJSA2S03f***kp208dy5w7",
"Version": "v4",
"Region": "us-east-1"
},
"HostPolicy": "follow_origin_domain"
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。