CreateRecord - 创建解析记录

在站点下创建一条DNS解析记录。

调试

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

授权信息

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

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

请求参数

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

站点 ID,可通过调用 ListSites 接口获取。

1234567890123
RecordNamestring

记录名称。

www.example.com
Proxiedboolean

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

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

记录的 DNS 类型。例如A/AAAACNAMETXT 等。

A/AAAA
SourceTypestring

CNAME 记录的源站类型。添加 CNAME 记录时,需要填写此参数。取值:

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

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

OSS
BizNamestring

记录加速时的业务场景,不开启加速的记录不需要传,取值:

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

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

30
Dataobject

记录的 DNS 信息。不同类型的记录,该字段需要传的内容也不同,请参考 说明文档

Valuestring

记录值或部分内容。添加 A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI 记录时,该参数必填。在不同类型的记录中,分别表示不同的含义:

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

记录的优先级,范围为0~65535。数值越小,优先级越高。添加 MX、SRV、URI 记录时,该参数必填。

10
Flaginteger

记录的标志位。CAA 记录的 Flag 指示其优先级和处理方式,取值范围为0~255。添加 CAA 记录时,该参数必填。

128
Tagstring

记录的标签。CAA 记录的 Tag 表示其具体类型和用途。添加 CAA 记录时,该参数必填。Tag 取值:

  • issue:表示授权某个 CA 颁发该域名的证书。后面一般跟着 CA 的域名。
  • issuewild:授权某个 CA 颁发该域名的通配符证书(例如 *.example.com)。
  • iodef:指定一个 URI,用于接收有关违反 CAA 记录的报告。
issue
Weightinteger

记录的权重,范围为0~65535。添加 SRV、URI 记录时,该参数必填。

0
Portinteger

记录的端口,范围为0~65535。添加 SRV 记录时,该参数必填。

0
Typeinteger

记录的证书类型(在 CERT 记录中),或公钥类型(在 SSHFP 记录中)。添加 CERT、SSHFP 记录时,该参数必填。

RSA
KeyTaginteger

记录的公钥标识,范围为0~65535。添加 CERT 记录时,该参数必填。

0
Algorithminteger

记录所采用的加密算法,范围为0~255。添加 CERT、SSHFP 记录时,该字段必填。

1
Certificatestring

记录的公钥证书信息。添加 CERT、SMIMEA 和 TLSA 记录时,该参数必填。

dGVzdGFkYWxrcw==
Usageinteger

记录的用途标识,范围为0~255。添加 SMIMEA 和 TLSA 时,该参数必填。

1
Selectorinteger

记录所使用的证书或公钥的类型,范围为0~255。添加 SMIMEA 和 TLSA 时,该参数必填。

1
MatchingTypeinteger

记录用于匹配或验证证书的算法策略,范围为0~255。添加 SMIMEA 和 TLSA 记录时,该参数必填。

1
Fingerprintstring

记录的公钥指纹值。添加 SSHFP 记录时,该参数必填。

abcdef1234567890
Commentstring

记录的备注信息,最大长度为 100 字符。

This is a remark.
AuthConfobject

CNAME 记录的源站鉴权信息。

AuthTypestring

源站鉴权类型,不同的源站类型,支持的鉴权类型不同,源站类型是指本接口中的 SourceType 参数,现在源站类型为 OSS 和 S3 时,需要填写源站鉴权类型,可选值:

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

源站所属账号的 AccessKey,当源站类型为 OSS 且源站鉴权类型为私有跨账号读,或者源站类型为 S3 且源站鉴权类型为私有读时,需要填写此值。

u0Nkg5gBK*******QF5wvKMM504JUHt
SecretKeystring

源站所属账号的 SecretKey,当源站类型为 OSS 且源站鉴权类型为私有跨账号读,或者源站类型为 S3 且源站鉴权类型为私有读时,需要填写此值。

VIxuvJSA2S03f******kp208dy5w7
Versionstring

签名算法版本,当源站类型为 S3 且源站鉴权类型为私有读时需要,支持以下两种:

  • v2
  • v4

不传时,默认为 v4。

v4
Regionstring

源站所属区域,当源站类型为 S3 时,需要填写此值,源站所属的区域需要在 S3 的官方网站上获取。

us-east-1
HostPolicystring

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

  • follow_hostname: 跟随请求 HOST。
  • follow_origin_domain: 跟随源站域名。
follow_origin_domain

记录的 Data 部分,包括记录的 DNS 信息。不同类型的记录,该字段需要传的内容也不同。详细说明请参考 说明文档

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

F61CDR30-E83C-4FDA-BF73-9A94CDD44229
RecordIdlong

创建的记录 ID。

1234567890123

示例

正常返回示例

JSON格式

{
  "RequestId": "F61CDR30-E83C-4FDA-BF73-9A94CDD44229",
  "RecordId": 1234567890123
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.输入参数规范校验失败。
400InvalidParameter.InvalidRecordNameThe record name you entered does not meet the specifications. Change the record name according to the product documentation.您输入的记录名称不符合规范,请根据产品文档调整记录名称。
400ServiceInvokeFailedThe call to the internal service failed. The engineer is resolving the problem. Please wait a moment before trying, or contact customer service for details.调用服务失败,请稍后重试或联系客服咨询详情。
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。
400InvalidParameter.RecordDataInvalid record content. Adjust your configurations based on the API documentation.记录内容参数错误,请根据接口文档调整参数内容。
400InvalidParameter.RecordTypeInvalid record type. Adjust your configurations based on the API documentation.记录类型错误,请根据接口文档调整参数内容。
400Instance.NotOnlineYour plan is unavailable due to an overdue payment. Complete the payment first.您的套餐实例因欠费当前处于非上线状态,请先完成续费操作以继续使用。
400QuotaExceed.RecordCountThe maximum number of records has been reached. Delete some and try again or upgrade your plan.记录数量已达上限,请删除部分记录后重试或升级套餐。
400Record.ConflictThe specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.和已有记录冲突,请根据冲突规则的产品文档调整记录内容。
400Site.ServiceBusyThis website is being configured. Try again later.该站点正在配置中,请稍后再试。
400SourceCircleExistThe host record of the resource to be operated on is already the source station of another resource, or the source station of the current resource has been added as a host record. To avoid loopback, modify the host record or source station and retry.当前要操作资源的主机记录已经是其他资源的源站,或者当前资源的源站已经被添加为主机记录,为避免回环产生,请修改主机记录或者源站后进行重试。
400QuotaExceed.WildCardRecordThe maximum number of wildcard records has been reached. Delete some and try again.泛域名记录数量已达上限,请删除部分泛域名记录后重试。

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

变更历史

变更时间变更内容概要操作
2024-11-05OpenAPI 错误码发生变更查看变更详情
2024-10-10OpenAPI 错误码发生变更查看变更详情
2024-09-24OpenAPI 错误码发生变更查看变更详情
2024-09-23OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情