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

批量设置Record Set状态

功能介绍

批量设置Record Set状态。

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

支持公网域名和内网域名的记录集。

调用方法

请参见如何调用API

URI

PUT /v2.1/recordsets/statuses

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

status

String

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

recordset_ids

Array of strings

待设置Record Set ID列表。

最多支持50个。

响应参数

状态码: 202

表2 响应Body参数

参数

参数类型

描述

recordsets

Array of recordsetData objects

设置record set的列表响应。

metadata

metadata object

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

表3 recordsetData

参数

参数类型

描述

id

String

Record Set的ID。

name

String

Record Set的名称。

description

String

Record Set的描述信息。

zone_id

String

托管该记录的zone_id。

zone_name

String

托管该记录的zone_name。

type

String

记录类型。

ttl

Integer

解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。

records

Array of strings

域名解析后的值。

created_at

String

创建时间。

updated_at

String

更新时间。

status

String

资源状态。

default

Boolean

标识是否由系统默认生成,系统默认生成的Record Set不能删除。

project_id

String

该Record Set所属的项目ID。

links

pageLink object

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

line

String

解析线路ID。

weight

Integer

解析记录的权重。

health_check_id

String

健康检查ID。

alias_target

alias_target object

别名记录。

表5 alias_target

参数

参数类型

描述

resource_type

String

资源服务类型,支持别名记录的服务。取值: cloudsite:云速建站 waf:Web应用防火墙

resource_domain_name

String

对应服务下的域名,由各服务提供。

表6 metadata

参数

参数类型

描述

total_count

Integer

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

状态码: 400

表7 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

状态码: 500

表8 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

批量设置解析记录的状态为暂停解析。

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

{
  "status" : "DISABLE",
  "recordset_ids" : [ "2c9eb155587228570158722b6ac30007", "2c9eb155587228570158722b6ac30008" ]
}

响应示例

状态码: 202

批量设置Record Set状态响应。

{
  "links" : {
    "self" : "https://Endpoint/v2.1/recordsets/statuses"
  },
  "recordsets" : [ {
    "id" : "2c9eb155587228570158722b6ac30007",
    "name" : "www.example.com.",
    "description" : "This is an example record set.",
    "type" : "A",
    "ttl" : 300,
    "records" : [ "192.168.10.2", "192.168.10.1" ],
    "status" : "DISABLE",
    "links" : {
      "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "created_at" : "2016-11-17T12:03:17.827",
    "updated_at" : null,
    "health_check_id" : "e55c6f3dc4e34c8e86353b664ae0e89f",
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "line" : "default_view",
    "weight" : 0
  }, {
    "id" : "2c9eb155587228570158722b6ac30008",
    "name" : "www.example.com.",
    "description" : "This is an example record set.",
    "type" : "A",
    "ttl" : 300,
    "records" : [ "192.168.10.2", "192.168.10.1" ],
    "status" : "DISABLE",
    "links" : {
      "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30008"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "created_at" : "2016-11-17T12:03:17.827",
    "updated_at" : null,
    "health_check_id" : "e55c6f3dc4e34c8e86353b664ae0e89c",
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "line" : "Abroad",
    "weight" : 0
  } ],
  "metadata" : {
    "total_count" : 2
  }
}

状态码

状态码

描述

202

批量设置Record Set状态响应。

400

接口错误响应。

500

接口错误响应。

错误码

请参见错误码

相关文档