You need to enable JavaScript to run this app.
导航

添加解析记录

最近更新时间2023.12.06 10:39:30

首次发布时间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。

Line

String

请求正文参数

解析记录对应的线路。默认为 default。该参数的值来自:



云解析 DNS 收到解析请求时,会先判断用户所在的线路,然后查找配置了该线路的解析记录。如果找到了,云解析 DNS 会返回解析结果。如果没有找到,云解析 DNS 不返回解析结果。

但对于 default 线路,云解析 DNS 不会做线路匹配,直接返回解析结果。default 线路的解析记录对所有线路都生效。

如果特定线路和 default 线路的记录同时存在,default 线路的优先级最低。也就是说,如果云解析 DNS 无法找到匹配的线路,则返回 default 线路的解析结果。

HostString请求正文参数主机记录。如果您为二级域名本身创建解析记录,该参数的值为 @

TTL

Integer

请求正文参数

解析记录的过期时间,单位是秒。该参数的默认是 600

Type

String

请求正文参数

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

  • A

  • AAAA

  • CNAME

  • NS

  • MX

  • SRV

  • TXT

  • CAA

Value

String

请求正文参数

表示一条记录值。关于不同类型记录的记录值格式,参见 解析记录类型

对于 A,AAAA,CNAME 类型的解析记录,您可以对多条 ZIDLineHostType 相同的解析记录指定不同的记录值。然后,您可以指定 Weight 对这些解析记录进行负载均衡。

WeightInteger请求正文参数表示解析记录的权重。默认值是 1。假设多条解析记录具有相同的 ZIDLineHostType ,但是 Value 不同。此时,权重指示了云解析 DNS 返回某条解析记录的概率。旗舰版的权重范围是 1-1000。其余版本的权重范围是 1-100。

响应正文

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:禁用。此时,该解析记录不生效。

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,
        "CreatedAt": "0001-01-01T08:05:43+08:05",
        "UpdatedAt": "0001-01-01T08:05:43+08:05",
        "Operators": [
            "224xxxxxxx011"
        ]
    }
}