文档首页/ 云解析服务 DNS/ API参考/ API/ 公网Zone管理/ 设置单个公网Zone状态
更新时间：2024-07-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置单个公网Zone状态

功能介绍

设置单个公网Zone状态，支持暂停、启用Zone

调用方法

请参见如何调用API。

URI

PUT /v2/zones/{zone_id}/statuses

表1 路径参数

参数

是否必选

参数类型

描述

zone_id

是

String

待设置状态Zone的ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

status

是

String

Zone状态。 取值范围： ENABLE：启用解析 DISABLE：暂停解析

响应参数

状态码： 202

表4 响应Body参数

参数

参数类型

描述

id

String

zone的ID，uuid形式的一个资源标识。

name

String

zone名称。

description

String

对zone的描述信息。

email

String

管理该zone的管理员邮箱。

zone_type

String

zone类型，公网（public）。

ttl

Integer

该zone下SOA记录中的ttl值。

serial

Integer

该zone下SOA记录中用于标识zone文件变更的序列值，用于主从节点同步。

status

String

资源状态。

record_num

Integer

该zone下的recordset个数。

pool_id

String

托管该zone的pool，由系统分配。

project_id

String

zone所属的项目ID。

created_at

String

创建时间。

updated_at

String

更新时间。

links

pageLink object

指向当前资源或者其他资源的链接。当查询需要分页时，需要包含一个next链接指向下一页。

masters

Array of strings

主从模式中，从DNS服务器获取DNS信息。目前暂未使用。
表5 pageLink

参数

参数类型

描述

self

String

当前资源的链接。

next

String

下一页资源的链接。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度：8

最大长度：36

message

String

错误描述

最小长度：2

最大长度：512

状态码： 500

表7 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度：8

最大长度：36

message

String

错误描述

最小长度：2

最大长度：512

请求示例

设置公网域名的状态为暂停解析。

PUT https://{endpoint}/v2/zones/{zone_id}/statuses

{
  "status" : "DISABLE"
}

响应示例

状态码： 202

更新公网Zone状态响应。

{
  "id" : "2c9eb155587194ec01587224c9f90149",
  "name" : "example.com.",
  "description" : "This is an example zone.",
  "email" : "xx@example.com",
  "ttl" : 300,
  "serial" : 0,
  "masters" : [ ],
  "status" : "DISABLE",
  "links" : {
    "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
  },
  "pool_id" : "00000000570e54ee01570e9939b20019",
  "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
  "zone_type" : "public",
  "created_at" : "2016-11-17T11:56:03.439",
  "updated_at" : "2016-11-17T11:56:05.528",
  "record_num" : 2
}

状态码

状态码

描述

202

更新公网Zone状态响应。

400

接口错误响应。

500

接口错误响应。

错误码

请参见错误码。

父主题： 公网Zone管理

相关文档