You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

添加解析记录

最近更新时间：2024.05.10 15:53:44

首次发布时间：2022.11.24 20:57:30

我的收藏

API 说明

API 名称：CreateRecord。
API 域名：open.volcengineapi.com。
API 描述：为指定的域名添加一条解析记录。

请求方法

POST

调用限制

每秒最多调用 10 次。

请求参数

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

参数名称数据类型参数类型是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 CreateRecord。
VersionString查询参数是API 的版本。该参数的取值是 2018-08-01。
ZIDInteger请求正文参数是需要添加解析记录的域名的 ID。您可以调用 ListZones API 获取域名 ID。
LineString请求正文参数否解析记录对应的线路。默认为 default。该参数的值来自： 域名可以配置的线路取决于该域名的 功能版本规格。
HostString请求正文参数是主机记录，即子域名的域名前缀。如果您需要为主域名添加解析记录，把该参数设置为 @。例如，@.example.com 代表 example.com。

TTL

Integer

请求正文参数

否

解析记录的过期时间，单位是秒。该参数的默认是 600。参见 功能版本规格 了解 TTL 的限制。

Type

String

请求正文参数

是

记录类型。该参数的取值如下：

  • A

  • AAAA

  • CNAME

  • NS

  • MX

  • SRV

  • TXT

  • CAA

ValueString请求正文参数是解析记录的记录值。关于不同类型记录的记录值格式，参见 解析记录类型。
WeightInteger请求正文参数否解析记录的权重。默认值是 1。参见 功能版本规格 了解权重的限制。
RemarkString请求正文参数否解析记录的备注。支持 UTF-8 编码且长度不超过 50 个字符。默认值是空字符串 ""。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称数据类型参数说明
RecordIDString解析记录的 ID。
FQDNString（已废弃）解析记录所包含的主机名，PQDN（Partially Qualified Domain Name） 格式。例如 www.example.com。
PQDNString解析记录所包含的主机名，PQDN（Partially Qualified Domain Name） 格式。例如 www.example.com。
HostString解析记录包含的主机记录。如果该参数值是 @，表示二级域名本身。
TypeString解析记录的类型。
TTLInteger解析记录的过期时间。单位是秒。
LineString解析记录对应的线路代号。关于该参数的值所对应的线路名称，您可以调用 ListLines API 获取。
ValueString添加的记录值。
WeightInteger解析记录的权重。
RecordSetIDString解析记录所在的记录集的 ID。只有 A，AAAA，CNAME 类型的解析记录有记录集。

Enable

Boolean

该解析记录是否是启用的。该参数有以下取值：

  • true：启用。

  • false：禁用。此时，该解析记录不生效。

RemarkString解析记录的备注。
CreatedAtString解析记录的创建时间。
UpdatedAtString该参数值与 CreatedAt 相同。
OperatorsString[]调用该 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"
        ]
    }
}