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

文档中心

立即注册

导航

TrafficRoute DNS 套件

UpdateZone-更新域名备注

最近更新时间：2024.06.27 16:31:01首次发布时间：2022.11.24 20:57:30

更新指定域名的备注。

使用说明

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

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`UpdateZone`	API 的名称。该参数的取值是 `UpdateZone`。
Version	String	是	`2018-08-01`	API 的版本。该参数的取值是 `2018-08-01`。

Body

名称	类型	是否必选	示例值	描述
ZID	Integer	是	`1234`	需要更新备注的域名 ID。您可以通过 CreateZone API 或 ListZones API 获取域名 ID。
Remark	String	否	`Remark`	该域名的备注。如果您不更新该参数，该域名的备注不会变更。

返回参数

ResponseMetadata 对象

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

Result 对象

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

示例

请求示例

POST https://open.volcengineapi.com?Version=2018-08-01&Action=UpdateZone
{
  "Remark": "update a domain",
  "ZID": 2652
}

响应示例

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

错误码

您可访问公共错误码，获取详细信息。