UpdateRecord - 更新解析记录--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

UpdateRecord - 更新解析记录

最近更新时间：2025.06.23 20:22:16首次发布时间：2022.11.24 20:57:30

更新一条解析记录。

使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateRecord	要执行的操作，取值：UpdateRecord。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
RecordID	String	是	3170534137672596377	需要更新的解析记录的 ID。
Host	String	是	@	主机记录，即子域名的域名前缀。如果您需要为主域名添加解析记录，把该参数设置为 `@`。例如，`@.example.com` 代表 `example.com`。
Line	String	是	default	解析记录对应的线路。该参数的值来自： ListLines API 返回的线路的 `Value` 参数。 ListCustomLines API 返回的线路的 `Line` 参数。域名可以配置的线路取决于该域名的功能版本规格。
ProjectName	String	否	default	所属项目名称
Type	String	否	A	记录类型。关于不同类型的记录，参见解析记录类型。如果您不设置该参数，该参数的值不变。
Value	String	否	203.0.113.0	解析记录的记录值。关于不同类型记录的记录值格式，参见解析记录类型。如果您不设置该参数，该参数的值不变。
Remark	String	否	Remark	解析记录的备注。支持 UTF-8 编码且长度不超过 16 个字符。如果您不设置该参数，该参数的值不变。
TTL	Integer	否	600	解析记录的过期时间。单位是秒。如果您不设置该参数，该参数的值不变。
Weight	Integer	否	1	解析记录的权重。参见功能版本规格了解权重的限制。只有解析记录所在的记录集开启了负载均衡，权重才有效。参见 UpdateRecordSet API。如果您不设置该参数，该参数的值不变。

返回参数

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

参数	类型	示例值	描述
CreatedAt	String	2023-04-12T11:21:15+08:00	解析记录的创建时间。
Enable	Boolean	true	该解析记录是否是启用的。该参数有以下取值： `true`：启用。 `false`：禁用。此时，该解析记录不生效。
FQDN	String	@.example.com	（已废弃）解析记录所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 `www.example.com`。
Host	String	@	主机记录，即子域名的域名前缀。如果您需要更新主域名的解析记录，把该参数设置为 `@`。例如，`@.example.com` 代表 `example.com`。
Line	String	default	解析记录对应的线路代号。关于该参数的值所对应的线路名称，您可以调用 ListLines API 获取。
Operators	Array of String	224xxxxxxx011	调用该 API 的火山引擎的账号 ID。如果是子用户调用该 API，该参数的值是子用户的 ID。
PQDN	String	@.example.com	解析记录所包含的主机名，PQDN（Partially Qualified Domain Name）格式。例如 `www.example.com`。
RecordID	String	3170534137672596377	解析记录的 ID。
RecordSetID	String	MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0	解析记录所在的记录集的 ID。只有 A，AAAA，CNAME 类型的解析记录有记录集。
Remark	String	remark	解析记录的备注。
Type	String	A	记录类型。关于不同类型的记录，参见解析记录类型。
TTL	Integer	600	解析记录的过期时间。单位是秒。
Tags	Array of String	["GTMLock"]	解析记录的标签信息。如果该参数的值包含 GTMLock，则说明该解析记录与火山引擎云调度（GTM）中的 GTM 实例关联。
UpdatedAt	String	2023-04-12T11:21:15+08:00	该 API 被调用后，解析记录更新的时间。
Value	String	203.0.113.0	添加的记录值。
Weight	Integer	1	解析记录的权重。

请求示例

POST /?Action=UpdateRecord&Version=2018-08-01 HTTP/1.1
Host: dns.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240908T103826Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240908/cn-beijing/dns/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Host": "@",
  "Line": "default",
  "RecordID": "3170534137672596377",
  "TTL": 600,
  "Type": "A",
  "Value": "2.2.2.2",
  "Weight": 1
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240908183849089111118096B966D9",
    "Action": "UpdateRecord",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
        "RecordID": "3170534137672596377",
        "FQDN": "@.example.com",
        "PQDN": "@.example.com",
        "Host": "@",
        "Type": "A",
        "TTL": 600,
        "Line": "default",
        "Value": "203.0.113.0",
        "Weight": 1,
        "RecordSetID": "MzE3MDUzNDEzNzY2OTA5ODc5OHxALnlhbWFzaXRlLnRvcC58QXxkZWZhdWx0",
        "Enable": true,
        "Remark": "",
        "CreatedAt": "2023-04-12T11:21:15+08:00",
        "UpdatedAt": "2023-04-12T11:21:15+08:00",
        "Operators": [
            "224512@210****11"
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	ErrParsingParams	parsing params error	解析请求失败。
400	ErrParamInvalid	validation fail:%s	参数校验失败。
400	ErrDBNotFound	record not found :%s	数据库条目未找到。
400	ErrZoneNotFound	zone not found	未找到域名。
400	ErrZoneInactive	zone is inactive	域名待找回。
400	ErrSpecNotValid	record %s not valid when creating record	参数不符合功能版本规格限制。
400	ErrLoadBalancerLimit	record load balancer count limited when creating record	记录组中记录数量超出功能版本规格限制。
500	ErrInternalServer	server internal error	服务内部错误。