You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /
  • TrafficRoute DNS 套件

更新域名备注

最近更新时间：2023.12.06 10:39:29

首次发布时间：2022.11.24 20:57:30

我的收藏

API 说明

API 名称：UpdateZone。
API 域名：open.volcengineapi.com。
API 描述：更新指定域名的备注。

请求方法

POST

调用限制

每秒最多调用 5 次。

请求参数

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

参数名称数据类型
参数类型
是否必选参数说明
ActionString查询参数是API 的名称。该参数的取值是 UpdateZone。
VersionString查询参数是API 的版本。该参数的取值是 2018-08-01。
ZIDInteger请求正文参数是需要更新备注的域名 ID。您可以通过 CreateZone API 或 ListZones API 获取域名 ID。
RemarkString请求正文参数否新的域名备注。默认为空字符串。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称数据类型参数说明
CreatedAtString域名的创建时间。
UpdatedAtString域名最近一次的更新时间。更新操作包括：
  • 更新域名备注
  • 在域名下创建解析记录
ZIDInteger域名的 ID。
ZoneNameString域名。
InstanceIDString实例的 ID。对于云解析 DNS 免费版，该字段的值为 null。
RemarkString域名的新备注。
ConfigurationCodeString该参数已弃用。
RecordCountInteger域名下的解析记录的总数。
ExpiredTimeInteger域名的过期时间。当前该参数值为 0，表示域名不会过期。
LastOperatorString最近一次更新该域名的用户的火山引擎账号 ID。更新操作包括更新域名备注、在该域名下创建解析记录等。

CacheStage

Integer

域名所有权的状态。该参数有以下取值：

  • 0：表示您是域名的所有者。

  • 1：表示您不是域名的所有者。

TradeCode

String

域名的功能版本。该参数有以下取值：

  • free_inner：免费版。

  • professional_inner：专业版。

  • enterprise_inner：企业版。

  • ultimate_inner：旗舰版。

  • ultimate_exclusive_inner：尊享版。

DnsSecurityStringDNS DDoS 防护服务的版本。
  • dns_security_standard_inner：安全防护标准版。
  • ""：无安全防护版。

示例

请求示例

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": "",
    }
}