UpdateZone - 更新域名备注--TrafficRoute DNS 套件-火山引擎

文档中心

TrafficRoute DNS 套件

域名管理

UpdateZone - 更新域名备注

更新指定域名的备注。

使用说明

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateZone	要执行的操作，取值：UpdateZone。
Version	String	是	2018-08-01	API的版本，取值：2018-08-01。
ZID	Long	是	1234	需要更新备注的域名 ID。您可以通过 CreateZone API 或 ListZones API 获取域名 ID。
Remark	String	否	update a domain	该域名的备注。如果您不更新该参数，该域名的备注不会变更。

返回参数

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

参数	类型	示例值	描述
CacheStage	Integer	1	域名所有权的状态。该参数有以下取值： `0`：表示您是域名的所有者。 `1`：表示您不是域名的所有者。
ConfigurationCode	String	null	该参数已弃用。
CreatedAt	String	2022-11-03T14:02:22+08:00	域名的创建时间。
DnsSecurity	String	dns_security_standard_inner	DNS DDoS 防护服务的版本。 `dns_security_standard_inner`：安全防护标准版。 `""`：无安全防护版。
ExpiredTime	Long	0	域名的过期时间。当前该参数值为 0，表示域名不会过期。
InstanceID	String	null	实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
IsSubDomain	Boolean	false	是否是子域名。 `true`：子域名。 `false`：主域名。
LastOperator	String	21xxxx72	最近一次更新该域名的用户的火山引擎账号 ID。更新操作包括更新域名备注、在该域名下创建解析记录等。
RecordCount	Integer	0	域名下的解析记录的总数。
Remark	String	update a domain	域名的新备注。
TradeCode	String	free_inner	域名的功能版本。该参数有以下取值： `free_inner`：免费版。 `professional_inner`：专业版。 `enterprise_inner`：企业版。 `ultimate_inner`：旗舰版。 `ultimate_exclusive_inner`：尊享版。
UpdatedAt	String	2022-11-03T14:04:25+08:00	域名最近一次的更新时间。更新操作包括：更新域名备注在域名下创建解析记录
ZID	Long	2652	域名的 ID。
ZoneName	String	test.com	域名。

请求示例

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

{
  "ZID": 1234,
  "Remark": "update a domain"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240831194404133118102026242F9A",
    "Action": "UpdateZone",
    "Version": "2018-08-01",
    "Service": "dns",
    "Region": "cn-beijing"
  },
  "Result": {
    "CacheStage": 1,
    "ConfigurationCode": null,
    "CreatedAt": "2022-11-03T14:02:22+08:00",
    "DnsSecurity": null,
    "ExpiredTime": 0,
    "InstanceID": "8",
    "IsSubDomain": true,
    "LastOperator": "21xxxx72",
    "RecordCount": 0,
    "Remark": "update a domain",
    "TradeCode": "free_inner",
    "UpdatedAt": "2022-11-03T14:04:25+08:00",
    "ZID": 2652,
    "ZoneName": "test.com"
  }
}

错误码

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

状态码	错误码	错误信息	说明
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:15

这个页面对您有帮助吗？

有用

无用

TrafficRoute DNS 套件

使用说明 #

请求说明 #

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #