Setting Record Set Status

Updated on 2024-03-25 GMT+08:00

View PDF

Function

This API is used to set record set status.

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	ID of the record set to be configured

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	String	Record set status. The value can be ENABLE or DISABLE.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Record set ID
name	String	Record set name
description	String	Record set description
zone_id	String	Zone ID of the record set
zone_name	String	Zone name of the record set
type	String	Record set type
ttl	Integer	Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect.
records	Array of strings	Record set value
created_at	String	Time when the record set was created
updated_at	String	Time when the record set was updated
status	String	Resource status
default	Boolean	Whether the record set is generated by the system. A system-generated record set cannot be deleted.
project_id	String	Project ID of the record set
links	pageLink object	Link of the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results.
line	String	Resolution line ID
weight	Integer	Weight of the record set
health_check_id	String	Health check ID
alias_target	alias_target object	Domain name alias
bundle	String	Specification, which is the default specification. This field is reserved.

**Table 5** pageLink
Parameter	Type	Description
self	String	Link to the current resource
next	String	Link to the next page

**Table 6** alias_target
Parameter	Type	Description
resource_type	String	Service that supports domain name aliases. Value options: cloudsite: CloudSite waf: Web Application Firewall
resource_domain_name	String	Domain name of the target service

Example Requests

Disabling a record set

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

{
  "status" : "DISABLE"
}

Example Responses

Status code: 200

Response to the request for batch setting record set status

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