更新时间:2024-12-19 GMT+08:00

批量设置Zone状态

功能介绍

批量设置Zone状态。

响应结果中只包含本次实际更新的Zone。

仅支持公网Zone、内网Zone。

调用方法

请参见如何调用API

URI

PUT /v2.1/zones/statuses

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

status

String

待设置Zone状态,当前仅支持DISABLE或ENABLE。

zone_ids

Array of strings

待设置Zone ID列表。

最多支持50个。

响应参数

状态码: 202

表2 响应Body参数

参数

参数类型

描述

zones

Array of zoneData objects

设置zone的列表响应。

metadata

metadata object

返回满足过滤条件的资源总数。

表3 zoneData

参数

参数类型

描述

id

String

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

name

String

zone名称。

description

String

对zone的描述信息。

email

String

管理该zone的管理员邮箱,用于生成该Zone的SOA记录。

zone_type

String

zone类型,取值 public 或 private。

ttl

String

该zone下SOA记录中的ttl值。

serial

String

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

status

String

资源状态。

record_num

String

该zone下的recordset个数。

pool_id

String

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

project_id

String

zone所属的项目ID。

created_at

String

创建时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ。

updated_at

String

更新时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ。

links

pageLink object

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

masters

String

主从模式中,从DNS服务器获取DNS信息。

表5 metadata

参数

参数类型

描述

total_count

Integer

满足查询条件的资源总数,不受分页(即limit、offset参数)影响。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

状态码: 500

表7 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

批量设置域名的状态为暂停解析。

PUT https://{endpoint}/v2.1/zones/statuses

{
  "status" : "DISABLE",
  "zone_ids" : [ "2c9eb155587194ec01587224c9f90149", "2c9eb155587194ec01587224c9f90150" ]
}

响应示例

状态码: 202

批量设置Zone状态响应。

{
  "links" : {
    "self" : "https://Endpoint/v2.1/zones/statuses"
  },
  "zones" : [ {
    "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
  }, {
    "id" : "2c9eb155587228570158722996c50001",
    "name" : "example.org.",
    "description" : "This is an example zone.",
    "email" : "xx@example.org",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "status" : "DISABLE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001"
    },
    "pool_id" : "00000000570e54ee01570e9939b20019",
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "zone_type" : "public",
    "created_at" : "2016-11-17T12:01:17.996",
    "updated_at" : "2016-11-17T12:01:18.528",
    "record_num" : 2
  } ],
  "metadata" : {
    "total_count" : 2
  }
}

状态码

状态码

描述

202

批量设置Zone状态响应。

400

接口错误响应。

500

接口错误响应。

错误码

请参见错误码