BatchCreateRecords - 批量创建解析记录

批量添加DNS解析记录,支持多种记录类型。

接口说明

该 API 允许用户一次性创建或更新多个 DNS 记录条目,适用于需要管理大量 DNS 配置的场景。支持的记录类型包括但不限于 A/AAAA、CNAME、NS、MX、TXT、CAA、SRV、URI 等,并提供了详细的配置项以满足特定需求,如优先级(Priority)、标志位(Flag)、标签(Tag)、权重(Weight)等。此外,对于特定类型的记录,如 CERT、SSHFP、SMIMEA 和 TLSA,还支持证书信息、加密算法等高级设置。

成功与失败的记录操作将在响应中分别列出,以便于用户了解哪些记录处理成功,哪些记录处理失败及其原因。

调试

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

授权信息

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

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

请求参数

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

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

1234567890123
RecordListarray<object>

待创建的 DNS 记录列表。

object

单个记录对象,包含记录的具体配置信息。

BizNamestring

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

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

记录的 DNS 信息,根据记录类型填写不同的字段。

Valuestring

记录值或部分内容。

  • A/AAAA:IP。
  • CNAME:指向的目标域名。
  • MX: 有效的目标邮件服务器域名。
  • TXT:有效的文本字符串。
  • CAA:有效的证书颁发机构域名。
  • SRV:有效的目标主机域名。
  • URI: 有效的 URI 字符串。
example.com
Priorityinteger

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

2
Flaginteger

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

128
Tagstring

CAA 记录的标签,表示其具体类型和用途,如 issue、issuewild、iodef 等。

issue
Weightinteger

记录的权重,范围为0~65535。适用于 SRV、URI 记录。

0
Portinteger

记录的端口,范围为0~65535。仅适用于 SRV 记录。

0
Typeinteger

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

0
KeyTaginteger

记录的公钥标识,范围为0~65535。适用于 CERT 记录。

0
Algorithminteger

记录所采用的加密算法,范围为0~255。适用于 CERT、SSHFP 记录。

0
Certificatestring

记录的公钥证书信息。适用于 CERT、SMIMEA 和 TLSA 记录。

dGVzdGFkYWxrcw==
Usageinteger

记录的用途标识,范围为0~255。适用于 SMIMEA 和 TLSA 记录。

0
Selectorinteger

记录所使用的证书或公钥的类型,范围为0~255。适用于 SMIMEA 和 TLSA 记录。

0
MatchingTypeinteger

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

0
Fingerprintstring

记录的公钥指纹值。适用于 SSHFP 记录。

abcdef1234567890
Ttlinteger

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

60
Typestring

记录的 DNS 类型。

A/AAAA
Proxiedboolean

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

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

记录名称。

www.example.com
SourceTypestring

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

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

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

OSS
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

返回参数

名称类型描述示例值
object

批量创建记录操作的响应结构。

RequestIdstring

请求 ID。

2430E05E-1340-5773-B5E1-B743929F46F2
RecordResultListobject

记录创建结果列表,包含成功和失败的记录详情。

Successarray<object>

成功的记录列表。

SuccessListobject
RecordIdlong

记录 ID。

1234567890123
RecordNamestring

记录名称。

www.example.com
RecordTypestring

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

A/AAAA
Descriptionstring

创建结果的信息描述。

success
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 记录。

128
Tagstring

CAA 记录的 Tag 表示其具体类型和用途,如 issue、issuewild、iodef。

issue
Weightinteger

记录的权重,范围为0~65535。适用于 SRV、URI 记录。

0
Portinteger

记录的端口,范围为0~65535。仅适用于 SRV 记录。

0
Typeinteger

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

0
KeyTaginteger

记录的公钥标识,范围为0~65535。适用于 CERT 记录。

0
Algorithminteger

记录所采用的加密算法,范围为0~255。适用于 CERT、SSHFP 记录。

0
Certificatestring

记录的公钥证书信息。适用于 CERT、SMIMEA 和 TLSA 记录。

dGVzdGFkYWxrcw==
Usageinteger

记录的用途标识,范围为0~255。适用于 SMIMEA 和 TLSA 记录。

0
Selectorinteger

记录所使用的证书或公钥的类型,范围为0~255。适用于 SMIMEA 和 TLSA 记录。

0
MatchingTypeinteger

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

0
Fingerprintstring

记录的公钥指纹值。适用于 SSHFP 记录。

abcdef1234567890
SourceTypestring

CNAME 记录的源站类型,其他类型记录此字段为空。源站类型取值:

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

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

60
BizNamestring

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

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

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

  • true:开启代理。
  • false:关闭代理加速。
true
Failedarray<object>

创建失败的记录列表。

SuccessListobject
RecordIdlong

创建的记录 ID。

1234567890123
RecordNamestring

记录名称。

a.example.com
RecordTypestring

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

A/AAAA
Descriptionstring

结果描述。

记录的名称非法
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 记录。

128
Tagstring

CAA 记录的标签,表示其具体类型和用途,如 issue、issuewild、iodef。

issue
Weightinteger

记录的权重。适用于 SRV、URI 记录。

0
Portinteger

记录的端口号,与 SRV 记录关联。仅适用于 SRV 记录。

0
Typeinteger

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

0
KeyTaginteger

记录的公钥标识,范围为0~65535。适用于 CERT 记录。

0
Algorithminteger

记录所采用的加密算法,范围为0~255。适用于 CERT、SSHFP 记录。

0
Certificatestring

记录的公钥证书信息。适用于 CERT、SMIMEA 和 TLSA 记录。

dGVzdGFkYWxrcw==
Usageinteger

记录的用途标识,范围为0~255。适用于 SMIMEA 和 TLSA 记录。

0
Selectorinteger

记录所使用的证书或公钥的类型,范围为0~255。适用于 SMIMEA 和 TLSA 记录。

0
MatchingTypeinteger

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

RSA
Fingerprintstring

记录的公钥指纹值。适用于 SSHFP 记录。

abcdef1234567890
SourceTypestring

CNAME 记录的源站类型,其他类型记录此字段为空。源站类型取值:

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

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

60
BizNamestring

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

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

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

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

创建操作的记录总数。

20

示例

正常返回示例

JSON格式

{
  "RequestId": "2430E05E-1340-5773-B5E1-B743929F46F2",
  "RecordResultList": {
    "Success": [
      {
        "RecordId": 1234567890123,
        "RecordName": "www.example.com",
        "RecordType": "A/AAAA",
        "Description": "success",
        "Data": {
          "Value": "example.com",
          "Priority": 10,
          "Flag": 128,
          "Tag": "issue",
          "Weight": 0,
          "Port": 0,
          "Type": 0,
          "KeyTag": 0,
          "Algorithm": 0,
          "Certificate": "dGVzdGFkYWxrcw==",
          "Usage": 0,
          "Selector": 0,
          "MatchingType": 0,
          "Fingerprint": "abcdef1234567890"
        },
        "SourceType": "OSS",
        "Ttl": 60,
        "BizName": "web",
        "Proxied": true
      }
    ],
    "Failed": [
      {
        "RecordId": 1234567890123,
        "RecordName": "a.example.com",
        "RecordType": "A/AAAA",
        "Description": "记录的名称非法",
        "Data": {
          "Value": "example.com",
          "Priority": 10,
          "Flag": 128,
          "Tag": "issue",
          "Weight": 0,
          "Port": 0,
          "Type": 0,
          "KeyTag": 0,
          "Algorithm": 0,
          "Certificate": "dGVzdGFkYWxrcw==",
          "Usage": 0,
          "Selector": 0,
          "MatchingType": 0,
          "Fingerprint": "abcdef1234567890"
        },
        "SourceType": "OSS",
        "Ttl": 60,
        "BizName": "web",
        "Proxied": true
      }
    ],
    "TotalCount": 20
  }
}

错误码

HTTP status code错误码错误信息描述
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。
400QuotaExceed.RecordCountThe maximum number of records has been reached. Delete some and try again or upgrade your plan.记录数量已达上限,请删除部分记录后重试或升级套餐。
400Site.ServiceBusyThis website is being configured. Try again later.该站点正在配置中,请稍后再试。
400Record.ConflictThe specified record content conflicts with existing records. Adjust your configurations based on the related product documentation.和已有记录冲突,请根据冲突规则的产品文档调整记录内容。
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.当前要操作资源的主机记录已经是其他资源的源站,或者当前资源的源站已经被添加为主机记录,为避免回环产生,请修改主机记录或者源站后进行重试。
400InvalidParameter.RecordsExceedLimitThe number of incoming records exceeds the maximum limit.传入的记录数量超过了最大数量限制。
400QuotaExceed.WildcardRecordCountThe number of wildcard records added by your current site has reached the quota limit. Please delete useless wildcard records or upgrade to the plan and try again.您当前站点添加的泛记录数量已经达到配额上限,请删除无用的泛记录或者升级到套餐后进行重试。

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

变更历史

变更时间变更内容概要操作
2024-11-12OpenAPI 错误码发生变更查看变更详情
2024-10-11OpenAPI 错误码发生变更查看变更详情
2024-09-24OpenAPI 错误码发生变更查看变更详情
2024-09-18OpenAPI 错误码发生变更查看变更详情