Setting the Record Set Status

Function

This API is used to set the record set status such as disabling and enabling a record set.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
recordset_id	Yes	String	Definition Record set ID Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	String	Definition Record set status Range ENABLE: Resolution is enabled. DISABLE: Resolution is disabled.

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Definition The record set ID. Range N/A
name	String	Definition The name of the record set. Range N/A
description	String	Definition The description of the record set. Range The value can contain a maximum of 255 characters.
zone_id	String	Definition The ID of the zone that hosts the record set. Range N/A
zone_name	String	Definition The zone that hosts the record set. Range N/A
type	String	Definition The type of the record set. Range Public zones: The value can be A, AAAA, MX, CNAME, TXT, SRV, NS, SOA or CAA. Private zones: The value can be A, AAAA, MX, CNAME, TXT, PTR, SRV, NS or SOA.
ttl	Integer	Definition The TTL of the record set in the local DNS server. It is measured in seconds. Longer TTLs reduce queries but delay updates. Range 1 to 2147483647
records	Array of strings	Definition The value returned for domain name resolution. Range N/A
created_at	String	Definition The time when the record set was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A
updated_at	String	Definition The time when the record set was last modified. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A
status	String	Definition The status of the record set. Range ACTIVE: The zone is normal. DISABLE: The zone is disabled.
default	Boolean	Definition Identifies whether the record set is created by default. A default record set cannot be deleted. Range N/A
project_id	String	Definition The ID of the project to which the record set belongs. Range N/A
links	pageLink object	Definition The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page. Range N/A
line	String	Definition The resolution line ID. Range N/A
weight	Integer	Definition The weight of the record set. Range 0 to 1000
health_check_id	String	Definition The health check ID. Range N/A
alias_target	alias_target object	Definition The alias record set. Range N/A
bundle	String	Definition Specification, which is the default specification. This field is reserved. Range N/A

**Table 5** pageLink
Parameter	Type	Description
self	String	Definition The link to the current page. Range N/A
next	String	Definition The link to the next page. Range N/A

**Table 6** alias_target
Parameter	Type	Description
resource_type	String	Definition Services that support domain name aliases Constraints N/A Range cloudsite: Enterprise Web Portal (EWP) waf: Web Application Firewall (WAF) Default Value N/A
resource_domain_name	String	Definition Domain name of the target service Constraints N/A Range N/A Default Value N/A

Example Requests

Disabling a record set

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

{
  "status" : "DISABLE"
}

Example Responses

Status code: 202

Request accepted

{
  "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
}