更新时间:2024-10-29 GMT+08:00

设置Record Set状态

功能介绍

设置Record Set状态

调用方法

请参见如何调用API

URI

PUT /v2.1/recordsets/{recordset_id}/statuses/set

表1 路径参数

参数

是否必选

参数类型

描述

recordset_id

String

待设置Record Set的ID信息。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

status

String

解析记录状态。 取值范围: ENABLE:启用解析 DISABLE:暂停解析。

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

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

别名记录。

bundle

String

规格,默认规格,保留字段。

表6 alias_target

参数

参数类型

描述

resource_type

String

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

resource_domain_name

String

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

请求示例

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

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

{
  "status" : "DISABLE"
}

响应示例

状态码: 202

设置Record Set状态响应。

{
  "id" : "2c9eb155587228570158722b6ac30007",
  "name" : "www.example.com.",
  "description" : "This is an example record set.",
  "type" : "A",
  "ttl" : 3600,
  "records" : [ "192.168.10.1", "192.168.10.2" ],
  "status" : "DISABLE",
  "links" : {
    "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
  },
  "zone_id" : "2c9eb155587194ec01587224c9f90149",
  "zone_name" : "example.com.",
  "created_at" : "2017-11-09T11:13:17.827",
  "updated_at" : "2017-11-10T12:03:18.827",
  "default" : false,
  "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
  "line" : "default_view",
  "weight" : 1,
  "health_check_id" : null
}

状态码

状态码

描述

200

设置Record Set状态响应。

错误码

请参见错误码