批量添加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:BatchCreateRecords | create | *Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SiteId | long | 是 | 站点 ID,可通过调用 ListSites 接口获取。 | 1234567890123 |
RecordList | array<object> | 是 | 待创建的 DNS 记录列表。 | |
object | 是 | 单个记录对象,包含记录的具体配置信息。 | ||
BizName | string | 否 | 记录加速时的业务场景,取值:
| web |
Data | object | 是 | 记录的 DNS 信息,根据记录类型填写不同的字段。 | |
Value | string | 否 | 记录值或部分内容。
| example.com |
Priority | integer | 否 | 记录的优先级,范围为0~65535。数值越小,优先级越高。添加 MX、SRV、URI 记录时,该参数必填。 | 2 |
Flag | integer | 否 | CAA 记录的标志位,指示其优先级和处理方式,取值范围为0~255。 | 128 |
Tag | string | 否 | CAA 记录的标签,表示其具体类型和用途,如 issue、issuewild、iodef 等。 | issue |
Weight | integer | 否 | 记录的权重,范围为0~65535。适用于 SRV、URI 记录。 | 0 |
Port | integer | 否 | 记录的端口,范围为0~65535。仅适用于 SRV 记录。 | 0 |
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 |
Ttl | integer | 是 | 记录的过期时间,单位秒。当取值为 1 时,表示记录的过期时间为自动。 | 60 |
Type | string | 是 | 记录的 DNS 类型。 | A/AAAA |
Proxied | boolean | 是 | 记录是否开启代理加速。只有 CNAME 记录与 A/AAAA 记录可以开启代理加速。取值:
| true |
RecordName | string | 是 | 记录名称。 | www.example.com |
SourceType | string | 否 | CNAME 记录的源站类型。添加 CNAME 记录时,需要填写此参数。取值:
该参数不传或传空时,则默认为 Domain,即普通域名源站类型。 | OSS |
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 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InternalException | Failed to call the service. Try again later or contact technical support. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
400 | QuotaExceed.RecordCount | The maximum number of records has been reached. Delete some and try again or upgrade your plan. | 记录数量已达上限,请删除部分记录后重试或升级套餐。 |
400 | Site.ServiceBusy | This website is being configured. Try again later. | 该站点正在配置中,请稍后再试。 |
400 | Record.Conflict | The specified record content conflicts with existing records. Adjust your configurations based on the related product documentation. | 和已有记录冲突,请根据冲突规则的产品文档调整记录内容。 |
400 | SourceCircleExist | The 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. | 当前要操作资源的主机记录已经是其他资源的源站,或者当前资源的源站已经被添加为主机记录,为避免回环产生,请修改主机记录或者源站后进行重试。 |
400 | InvalidParameter.RecordsExceedLimit | The number of incoming records exceeds the maximum limit. | 传入的记录数量超过了最大数量限制。 |
400 | QuotaExceed.WildcardRecordCount | The 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-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-10-11 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-09-24 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-09-18 | OpenAPI 错误码发生变更 | 查看变更详情 |