CreateRecord - 添加解析记录--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

CreateRecord - 添加解析记录

最近更新时间：2025.05.22 19:59:49首次发布时间：2023.02.08 13:12:16

为一个域名添加一条解析记录。

使用说明

请求频率：每秒最多调用 10 次。

请求说明

请求方式：POST
请求地址：https://private-zone.volcengineapi.com/?Action=CreateRecord?Version=2022-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	CreateRecord	要执行的操作，取值：CreateRecord。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
ZID	Long	是	1234	域名 ID。您可以通过以下 API 获取： CreatePrivateZone API ListPrivateZones API
Type	String	是	A	记录类型。关于不同类型的记录，参见解析记录类型。该参数的取值如下： A：A 记录。 AAAA：AAAA 记录。 CNAME：CNAME 记录。 TXT：TXT 记录。 MX：MX 记录。 PTR：PTR 记录。 A：A 记录。 AAAA：AAAA 记录。 CNAME：CNAME 记录。 TXT：TXT 记录。 MX：MX 记录。 PTR：PTR 记录。
Host	String	是	abc	子域名的域名前缀。参见添加解析记录了解域名前缀的格式要求。
Value	String	是	10.0.0.1	记录值。参见解析记录类型。
Line	String	否	default	解析记录的线路。可以是 `default` 或一个 VPC 子网 ID。您必须在调用 CreatePrivateZone API 时开启智能解析。否则，该参数无效。默认值为 `default`。此时，解析记录使用默认线路 `0.0.0.0/0`。
Remark	String	否	remark	备注。支持 UTF-8 字符。不能超过 16 个字符。默认值为空字符串。
TTL	Integer	否	600	解析记录的过期时间。单位为秒。默认值为 600。
Weight	Integer	否	1	记录值的权重。只有域名开启了负载均衡后，记录值的权重才会生效。参见 UpdatePrivateZone API 了解如何为域名开启或关闭负载均衡。默认值为 1。
ClientToken	String	否	123456abcdef	用于确保请求的幂等性。如果您设置了该参数，在相同的请求参数下，无论该 API 被调用多少次，返回的结果都是相同的。该参数仅允许 ASCII 字符且不能超过 64 个字符。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
RecordID	String	9079256848778957482	标识解析记录的唯一 ID。

请求示例

POST https://private-zone.volcengineapi.com/?Action=CreateRecord&Version=2022-06-01

{
    "ZID": 1068,
    "Host": "www",
    "Value": "10.0.0.1",
    "Type": "A",
    "Weight": 10,
    "TTL": 600,
    "Line": "default",
    "Remark":""
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20221215101225DB0A30AF803D07576779",
        "Action": "CreateRecord",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "RecordID": "9079256848778957482"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrParamInvalid	validation fail: params:[%s] , value:[%v]	参数校验失败
400	ErrZoneNotFound	zone not found	未找到域名
400	ErrQuotaExceeded	[%s] exceeds quota [%d]	[%s] 超出限额 [%d]
400	ErrIdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s)	幂等请求参数不一致
400	ErrIdempotentRequestInProgress	last idempotent request is in progress, please try later	上一次幂等请求还没结束，请稍后重试
400	ErrDBDuplicated	duplicated: domain name:iaas-api.console.volcengine.com. already have duplicate record in same line	相同线路下的解析记录重复
400	ErrHostCanNotBeEmpty	host can't be empty, use @ instead	域名前缀不能为空
500	ErrInternalServer	server internal error	服务内部错误