ListRecords - 查询解析记录列表_边缘安全加速(ESA)-阿里云帮助中心

查询站点下解析记录列表，包括记录值、优先级、认证配置等。支持根据记录名称、记录类型等条件进行过滤。

接口说明

边缘容器、边缘函数与四层加速对应的 DNS 解析记录，将不会在此 API 中返回。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
esa:ListRecords	get	Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId}	无	无

请求参数

名称	类型	必填	描述	示例值
SiteId	long	是	站点 ID，可通过调用 ListSites 接口获取。	1234567890123
RecordName	string	否	记录名称。用于查询的过滤条件。	www.example.com
RecordMatchType	string	否	记录名称的搜索匹配模式。默认为精确匹配，取值： prefix：前缀匹配。 suffix：后缀匹配。 excat：精确匹配。 fuzzy：模糊匹配。	fuzzy
PageNumber	integer	否	页码，默认值为 1。	1
PageSize	integer	否	分页大小，默认 500。	10
SourceType	string	否	记录的源站类型，用于查询的过滤条件（仅 CNAME 记录可以通过该字段筛选），取值： OSS：OSS 源站。 S3：S3 源站。 LB：负载均衡器源站。 OP：源地址池源站。 Domain：普通域名源站。	OSS
BizName	string	否	记录加速时的业务场景，用于查询的过滤条件，取值： image_video：视频图片。 api：api 接口。 web：web 网页。	web
Proxied	string	否	记录是否开启代理加速，用于查询的过滤条件。取值： true：开启代理。 false：关闭代理加速。	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 信息，详情请参考说明文档。
recordPageData	object	单个记录信息。
BizName	string	记录加速时的业务场景，取值： image_video：视频图片。 api：api 接口。 web：web 网页。	web
Data	object	记录的具体 DNS 信息。不同类型记录包含不同的信息。
Value	string	记录值或部分内容。A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI 记录含有该参数。在不同类型的记录中，分别表示不同的含义： A/AAAA：指向的 ip 地址。多个 ip 时，用半角逗号,分隔。至少需要有一个 ipv4 地址。 CNAME：指向的目标域名。 NS：指定域名的名称服务器。 MX: 有效的目标邮件服务器域名。 TXT：有效的文本字符串。 CAA：有效的证书颁发机构域名。 SRV：有效的目标主机域名。 URI: 有效的 URI 字符串。	CNAME
Priority	integer	记录的优先级，范围为 0 到 65535。数值越小，优先级越高。MX、SRV、URI 记录独有。	0
Flag	integer	记录的标志位。CAA 记录的 Flag 指示其优先级和处理方式，取值范围为 0 到 255。CAA 记录独有。	128
Tag	string	记录的标签。CAA 记录的 Tag 表示其具体类型和用途。CAA 记录独有。	issue
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
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：开启代理。 false：关闭代理加速。	true
RecordId	long	记录 ID。	1234567890123
RecordSourceType	string	CNAME 记录的源站类型。添加 CNAME 记录时，需要填写此参数。取值： OSS：OSS 源站。 S3：S3 源站。 LB：负载均衡器源站。 OP：源地址池源站。 Domain：普通域名源站。该参数不传或传空时，则默认为 Domain，即普通域名源站类型。	OSS
RecordName	string	记录名称。	a.example.com
RecordType	string	记录的 DNS 类型。如A/AAAA、CNAME、TXT等。	A/AAAA
SiteId	long	记录所属站点的 ID。	1234567890123
SiteName	string	记录所属站点的名称。	example.com
Ttl	long	记录的过期时间，单位秒。当取值为 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 时，需要填写源站鉴权类型，可选值： public：公共读，当源站类型为 OSS 或 S3，且源站为公共读时为该参数。 private: 私有读，当源站类型为 S3，且源站为私有读时为该参数。 private_same_account: 私有同账号读，当源站类型为 OSS，在同一个阿里云账号下，且源站为私有读时为该参数。 private_cross_account: 私有跨账号读，当源站类型为 OSS，不在同一个阿里云账号下，且源站为私有读时为该参数。	private
AccessKey	string	源站所属账号的 AccessKey，当源站类型为 OSS 且源站鉴权类型为私有跨账号读，或者源站类型为 S3 且源站鉴权类型为私有读时有该参数。	u0Nkg5gBK***QF5wvKMM504JUHt
SecretKey	string	源站所属账号的 SecretKey，当源站类型为 OSS 且源站鉴权类型为私有跨账号读，或者源站类型为 S3 且源站鉴权类型为私有读时有该参数。	VIxuvJSA2S03f***kp208dy5w7
Version	string	签名算法版本，当源站类型为 S3 且源站鉴权类型为私有读时有该参数，支持以下两种： v2 v4 不传时，默认为 v4。	v4
Region	string	源站所属区域，当源站类型为 S3 时有该参数，源站所属的区域需要在 S3 的官方网站上获取。	us-east-1
HostPolicy	string	回源 HOST 策略，记录类型为 CNAME 时生效，设置回源时带 HOST 的策略，有两种模式： follow_hostname: 跟随请求 HOST。 follow_origin_domain: 跟随源站域名。	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,
        "Tag": "issue",
        "Weight": 0,
        "Port": 80,
        "Type": 0,
        "KeyTag": 0,
        "Algorithm": 0,
        "Certificate": "dGVzdGFkYWxrcw==",
        "Usage": 0,
        "Selector": 0,
        "MatchingType": 0,
        "Fingerprint": "abcdef1234567890"
      },
      "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.	调用服务失败，请稍后重试或联系客服咨询详情。

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

变更历史

变更时间	变更内容概要	操作
2024-09-23	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情