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

文档中心

立即注册

导航

TrafficRoute DNS 套件

CreateRecord-添加解析记录

最近更新时间：2024.12.10 10:36:52首次发布时间：2023.02.08 13:12:16

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

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`CreateRecord`	API 的名称。该参数的取值是 `CreateRecord`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。

Body

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

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在地域。

Result 对象

名称	类型	描述
RecordID	String	标识解析记录的唯一 ID。

示例

请求示例

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

{
    "ZID": 1068,
    "Host": "www",
    "Value": "1.1.1.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"
    }
}

错误码

您可访问公共错误码，获取详细信息。