UpdatePrivateZone-更新域名配置--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

UpdatePrivateZone-更新域名配置

最近更新时间：2024.08.23 14:20:20首次发布时间：2023.02.08 13:11:01

更新指定域名的配置。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdatePrivateZone?Version=2022-06-01

请求参数

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

Query

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

Body

名称	类型	是否必选	示例值	描述
ZID	Integer	是	`123456`	标识域名的唯一 ID。您可以通过以下 API 获取：添加域名 API 获取域名列表 API
RecursionMode	Boolean	否	`true`	开启或关闭递归解析。 true：开启递归解析。 false：不开启递归解析。如果您不设置该参数，该参数的值不会变化。
LoadBalance	Boolean	否	`true`	开启或关闭负载均衡。 true：开启负载均衡。 false：关闭负载均衡。如果您不设置该参数，该参数的值不会变化。
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	域名。
Remark	String	域名备注。
RecordCount	Integer	解析记录的数量。
RecursionMode	Boolean	域名是否开启了递归解析。 true：域名开启了递归解析。 false：域名未开启递归解析。
LineMode	Integer	域名是否开启了智能解析和负载均衡。 0：域名关闭了智能解析和负载均衡。 1：域名开启了负载均衡，同时关闭了智能解析。 2：域名关闭了负载均衡，同时开启了智能解析。 3：域名开启了智能解析和负载均衡。
LastOperator	String	表示添加该域名的火山引擎账号的 ID。
Region	String[]	VPC 所在的地域。
Global	Boolean	该参数无实际意义。您可以忽略该参数。

示例

请求示例

POST https://open.volcengineapi.com/?Action=UpdatePrivateZone&Version=2022-06-01

{
    "ZID": 1013,
    "RecursionMode": true,
    "LoadBalance": 0
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022121415294112C656E4424DFF5272EC",
        "Action": "UpdatePrivateZone",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    },
    "Result": {
        "CreatedAt": "2022-12-14T14:05:53+08:00",
        "UpdatedAt": "2022-12-14T15:29:41+08:00",
        "ZID": 1013,
        "ZoneName": "internal003.com",
        "Remark": "",
        "RecursionMode": true,
        "RecordCount": 0,
        "LineMode": 0,
        "LastOperator": "2100054541",
        "Region": [
            "华北2（北京）|cn-beijing"
        ],
        "Global": false
    }
}

错误码

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