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

文档中心

立即注册

导航

CreateRecord-添加解析记录

最近更新时间：2024.07.18 16:27:23首次发布时间：2022.11.24 20:57:30

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

使用说明

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

请求说明

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

请求参数

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

Query

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

Body

名称	类型	是否必选	示例值	描述
ZID	Integer	是	`1234`	需要添加解析记录的域名的 ID。您可以调用 ListZones API 获取域名 ID。
Line	String	否	`Default`	解析记录对应的线路。默认为 `default`。该参数的值来自： ListLines API 返回的线路的 `Value` 参数。 ListCustomLines API 返回的自定义线路的 `Line` 参数。域名可以配置的线路取决于该域名的功能版本规格。
Host	String	是	`@`	主机记录，即子域名的域名前缀。如果您需要为主域名添加解析记录，把该参数设置为 `@`。例如，`@.example.com` 代表 `example.com`。
TTL	Integer	否	`600`	解析记录的过期时间，单位是秒。该参数的默认是 `600`。参见功能版本规格了解 TTL 的限制。
Type	String	是	`A`	记录类型。关于不同类型的记录，参见解析记录类型。该参数的取值如下： `A`：A 记录。 `AAAA`：AAAA 记录。 `CNAME`：CNAME 记录。 `NS`：NS 记录。 `MX`：MX 记录。 `SRV`：SRV 记录。 `TXT`：TXT 记录。 `CAA`：CAA 记录。
Value	String	是	`1.1.1.1`	解析记录的记录值。关于不同类型记录的记录值格式，参见解析记录类型。
Weight	Integer	否	`1`	解析记录的权重。默认值是 `1`。参见功能版本规格了解权重的限制。只有解析记录所在的记录集开启了负载均衡，权重才有效。参见 UpdateRecordSet API。
Remark	String	否	`Remark`	解析记录的备注。支持 UTF-8 编码且长度不超过 255 个字符。默认值是空字符串 `""`。

返回参数

ResponseMetadata 对象

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

Result 对象

名称	类型	描述
RecordID	String	解析记录的 ID。
FQDN	String	（已废弃）解析记录所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 `www.example.com`。
PQDN	String	解析记录所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 `www.example.com`。
Host	String	解析记录包含的主机记录。如果该参数值是 `@`，表示二级域名本身。
Type	String	记录类型。关于不同类型的记录，参见解析记录类型。该参数的取值如下： `A`：A 记录。 `AAAA`：AAAA 记录。 `CNAME`：CNAME 记录。 `NS`：NS 记录。 `MX`：MX 记录。 `SRV`：SRV 记录。 `TXT`：TXT 记录。
TTL	Integer	解析记录的过期时间。单位是秒。
Line	String	解析记录对应的线路代号。关于该参数的值所对应的线路名称，您可以调用 ListLines API 获取。
Value	String	添加的记录值。
Weight	Integer	解析记录的权重。
RecordSetID	String	解析记录所在的记录集的 ID。只有 A，AAAA，CNAME 类型的解析记录有记录集。
Enable	Boolean	该解析记录是否是启用的。该参数有以下取值： `true`：启用。 `false`：禁用。此时，该解析记录不生效。
Remark	String	解析记录的备注。
CreatedAt	String	解析记录的创建时间。
UpdatedAt	String	该参数值与 `CreatedAt` 相同。
Operators	String[]	调用该 API 的火山引擎的账号 ID。如果是子用户调用该 API，该参数的值是子用户的 ID。

示例

请求示例

POST https://open.volcengineapi.com?Version=2018-08-01&Action=CreateRecord
{
  "Host": "test",
  "Line": "default",
  "TTL": 600,
  "Type": "A",
  "Value": "1.1.1.1",
  "Weight": 1,
  "ZID": 1234
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230412112114550833F5F122DBDA0276",
        "Action": "CreateRecord",
        "Version": "2018-08-01",
        "Service": "dns",
        "Region": "cn-north-1"
    },
    "Result": {
        "RecordID": "3170534137672596377",
        "FQDN": "@.example.com",
        "PQDN": "@.example.com",
        "Host": "@",
        "Type": "A",
        "TTL": 600,
        "Line": "default",
        "Value": "1.1.1.1",
        "Weight": 1,
        "RecordSetID": "MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0",
        "Enable": true,
        "Remark": "",
        "CreatedAt": "0001-01-01T08:05:43+08:05",
        "UpdatedAt": "0001-01-01T08:05:43+08:05",
        "Operators": [
            "224xxxxxxx011"
        ]
    }
}

错误码

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