On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Domain Name Service/ API Reference/ APIs/ Batch Operations/ Batch Setting the Status of Record Sets

Batch Setting the Status of Record Sets

Updated on 2025-01-08 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to set the status of record sets in batches. The response contains only the record sets that are updated. Record sets of both public and private zones are supported.

Calling Method

For details, see Calling APIs.

URI

PUT /v2.1/recordsets/statuses

Request Parameters

**Table 1** Request body parameters
Parameter	Mandatory	Type	Description
status	Yes	String	Record set status. The value can only be DISABLE or ENABLE.
recordset_ids	Yes	Array of strings	ID list of record sets to be set. You can specify a maximum of 50 IDs.

Response Parameters

Status code: 202

**Table 2** Response body parameters
Parameter	Type	Description
links	Link object	Link to the current resource.
recordsets	Array of RecordsetData objects	Response to the request for setting the status of record sets in batches
metadata	metadata object	Number of resources that meet the query condition.

**Table 3** RecordsetData
Parameter	Type	Description
id	String	Record set ID
name	String	Record set name
description	String	Record set description
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
status	String	Resource status
zone_id	String	Zone ID of the record set
zone_name	String	Zone name of the record set
line	String	Resolution line ID
alias_target	alias_target object	Domain name alias
created_at	String	Time when the record set was created
updated_at	String	Time when the record set was updated
health_check_id	String	Health check ID
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	Link object	Link to the current resource.
weight	Integer	Weight of the record set

**Table 4** 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

**Table 5** Link
Parameter	Type	Description
self	String	Link to the current resource.

**Table 6** metadata
Parameter	Type	Description
total_count	Integer	Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Error code
message	String	Description

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Error code
message	String	Description

Example Requests

Disabling record sets

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

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

Example Responses

Status code: 202

Response to the request for batch setting record set status

{
  "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",
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "line" : null,
    "alias_target" : null,
    "created_at" : "2016-11-17T12:03:17.827",
    "updated_at" : "2016-11-17T12:56:03.827",
    "health_check_id" : null,
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "links" : {
      "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
    },
    "weight" : null
  }, {
    "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",
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "line" : null,
    "alias_target" : null,
    "created_at" : "2016-11-17T12:03:17.827",
    "updated_at" : "2016-11-17T12:56:03.827",
    "health_check_id" : null,
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c",
    "links" : {
      "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30008"
    },
    "weight" : null
  } ],
  "metadata" : {
    "total_count" : 2
  }
}