GetRecord - 查询解析记录详情

获取单条DNS解析记录的详细配置信息,包括记录值、优先级、回源鉴权配置(CNAME记录独有)等。

调试

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

授权信息

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

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

请求参数

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

记录的 ID,可以通过 ListRecords 获取。

1234567890123

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

F32C57AA-7BF8-49AE-A2CC-9F42390F5A19
RecordModelobject

查询到的单个记录信息。

BizNamestring

记录加速时的业务场景。取值:

  • image_video:视频图片。
  • api:api 接口。
  • web:web 网页。
image_video
Dataobject

记录的 DNS 信息。不同类型的记录,该字段返回的内容也不同。

Valuestring

记录值或部分内容。在不同类型的记录中,分别表示不同的含义:

  • A/AAAA:指向的 Ip 地址。多个 Ip 时,用","分隔。至少需要有一个 Ipv4 地址。
  • CNAME:指向的目标域名。
  • NS:指定域名的名称服务器。
  • MX: 有效的目标邮件服务器域名。
  • TXT:有效的文本字符串。
  • CAA:有效的证书颁发机构域名。
  • SRV:有效的目标主机域名。
  • URI: 有效的 URI 字符串。
example.com
Priorityinteger

记录的优先级。范围为0~65535。数值越小,优先级越高。

10
Flaginteger

记录的标志位。CAA 记录的 Flag 指示其优先级和处理方式,取值范围为0~255

128
Tagstring

记录的标签。CAA 记录的 Tag 表示其具体类型和用途。

issue
Weightinteger

记录的权重,范围为0~65535

0
Portinteger

记录的端口。范围为0~65535

8707
Typeinteger

记录的证书类型(在 CERT 记录中),或公钥类型(在 SSHFP 记录中)。

RSA
KeyTaginteger

记录的公钥标识,范围为0~65535

1
Algorithminteger

记录所采用的加密算法。范围为0~255

1
Certificatestring

记录的公钥证书信息。

dGVzdGFkYWxrcw==
Usageinteger

记录的用途标识。范围为0~255

0
Selectorinteger

记录所使用的证书或公钥的类型。范围为0~255

1
MatchingTypeinteger

记录用于匹配或验证证书的算法策略。范围为0~255

1
Fingerprintstring

记录的公钥指纹值。

abcdef1234567890
CreateTimestring

记录的创建时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-03-10T13:30:39Z
UpdateTimestring

记录的更新时间,日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。

2023-01-27T02:26:22Z
Proxiedboolean

记录是否开启代理加速。只有 CNAME 记录与 A/AAAA 记录可以开启代理加速。取值:

  • true:开启代理。
  • false:关闭代理加速。
true
RecordIdlong

记录 ID。

1234567890123
RecordNamestring

记录名称。

a.example.com
RecordTypestring

记录的 DNS 类型。如A/AAAA、CNAME、TXT等。

A/AAAA
SiteIdlong

站点 ID。

1234567890123
SiteNamestring

站点名称。

example.com
Ttlinteger

记录的过期时间,单位秒。当取值为 1 时,表示记录的过期时间为自动。

20
RecordSourceTypestring

CNAME 记录的源站类型。取值:

  • OSS:OSS 源站。
  • S3:S3 源站。
  • LB:负载均衡器源站。
  • OP:源地址池源站。
  • Domain:普通域名源站。

该参数不传或传空时,则默认为 Domain,即普通域名源站类型。

OSS
RecordCnamestring

记录的 CNAME。

a.example.com.cnamezone.com
Commentstring

记录的备注信息。

这是一个备注信息
AuthConfobject

CNAME 记录的源站鉴权信息。

AuthTypestring

源站鉴权类型。可选值:

  • public:公共读,当源站类型为 OSS 或 S3,且源站为公共读时,选此值。
  • private: 私有读,当源站类型为 S3,且源站为私有读时,选此值。
  • private_same_account: 私有同账号读,当源站类型为 OSS,在同一个阿里云账号下,且源站为私有读时,选此值。
  • private_cross_account: 私有跨账号读,当源站类型为 OSS,不在同一个阿里云账号下,且源站为私有读时,选此值。
public
SecretKeystring

源站所属账号的 AccessKey。

u0Nkg5gBK*******QF5wvKMM504JUHt
AccessKeystring

源站所属账号的 AccessKey。

VIxuvJSA2S03f******kp208dy5w7
Versionstring

签名算法版本。支持以下两种:

  • v2
  • v4

不传时,默认为 v4。

v2
Regionstring

源站所属区域。源站所属的区域需要在 S3 的官方网站上获取。

us-east-1
HostPolicystring

回源 HOST 策略,记录类型为 CNAME 时生效,设置回源时带 HOST 的策略,有两种模式:

  • follow_hostname: 跟随主机记录。
  • follow_origin_domain: 跟随源站域名。
follow_origin_domain

示例

正常返回示例

JSON格式

{
  "RequestId": "F32C57AA-7BF8-49AE-A2CC-9F42390F5A19",
  "RecordModel": {
    "BizName": "image_video",
    "Data": {
      "Value": "example.com",
      "Priority": 10,
      "Flag": 128,
      "Tag": "issue",
      "Weight": 0,
      "Port": 8707,
      "Type": 0,
      "KeyTag": 1,
      "Algorithm": 1,
      "Certificate": "dGVzdGFkYWxrcw==",
      "Usage": 0,
      "Selector": 1,
      "MatchingType": 1,
      "Fingerprint": "abcdef1234567890"
    },
    "CreateTime": "2023-03-10T13:30:39Z",
    "UpdateTime": "2023-01-27T02:26:22Z",
    "Proxied": true,
    "RecordId": 1234567890123,
    "RecordName": "a.example.com",
    "RecordType": "A/AAAA",
    "SiteId": 1234567890123,
    "SiteName": "example.com",
    "Ttl": 20,
    "RecordSourceType": "OSS ",
    "RecordCname": "a.example.com.cnamezone.com",
    "Comment": "这是一个备注信息",
    "AuthConf": {
      "AuthType": "public",
      "SecretKey": "u0Nkg5gBK*******QF5wvKMM504JUHt",
      "AccessKey": "VIxuvJSA2S03f******kp208dy5w7",
      "Version": "v2",
      "Region": "us-east-1"
    },
    "HostPolicy": "follow_origin_domain"
  }
}

错误码

HTTP status code错误码错误信息描述
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。
404Record.NotFoundThe record does not exist. Check your configurations and try again.传入的请求记录不存在,请检查您的输入参数后重试。

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

变更历史

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