UpdateRecordStatus - 启用或禁用解析记录--TrafficRoute DNS 套件-火山引擎

文档中心

TrafficRoute DNS 套件

解析记录管理

UpdateRecordStatus - 启用或禁用解析记录

启用或者禁用一条解析记录。

使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateRecordStatus	要执行的操作，取值：UpdateRecordStatus。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
RecordID	String	是	3170534137672596377	解析记录的 ID。
Enable	Boolean	否	true	是否启用该解析记录。该参数有以下取值： `true`：启用该解析记录。被启用的解析记录才会被返回。 `false`（默认）：禁用该解析记录。被禁用的解析记录不会被返回。如果您不设置该参数，该参数的值不变。
ProjectName	String	否	default	解析记录的域名所属项目。默认为 `default`。

返回参数

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

参数	类型	示例值	描述
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	@	解析记录包含的主机记录。如果该参数值是 @，表示二级域名本身。
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	记录类型。关于不同类型的记录，参见解析记录类型。该参数的取值如下： `A`：A 记录。 `AAAA`：AAAA 记录。 `CNAME`：CNAME 记录。 `NS`：NS 记录。 `MX`：MX 记录。 `SRV`：SRV 记录。 `TXT`：TXT 记录。
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=UpdateRecordStatus&Version=2018-08-01 HTTP/1.1
Host: dns.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240908T105012Z
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

{
  "RecordID": "3170534137672596377",
  "Enable": false
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202409081850210060131390668423EA",
    "Action": "UpdateRecordStatus",
    "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": false,
        "CreatedAt": "2023-04-12T11:21:15+08:00",
        "UpdatedAt": "2023-04-12T11:34:23+08:00",
        "Operators": [
            "2245xxxxx42011"
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
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	域名待找回。
500	ErrInternalServer	server internal error	服务内部错误。

最近更新时间：2025.06.23 20:22:16

这个页面对您有帮助吗？

有用

无用

TrafficRoute DNS 套件

使用说明 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #