Batch Modifying Record Sets

Function

This API is used to batch modify record sets. This operation is atomic. It either modifies all record sets or does not modify any record set. Only public zones are supported.

Calling Method

For details, see Calling APIs.

URI

PUT /v2.1/zones/{zone_id}/recordsets

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
zone_id	Yes	String	Zone ID

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
recordsets	Yes	Array of batchUpdateRecordSet objects	Record set list

**Table 4** batchUpdateRecordSet
Parameter	Mandatory	Type	Description
id	Yes	String	Record set ID
description	No	String	Record set description
ttl	No	Integer	Caching duration of the record set, in seconds. The value ranges from 300 to 2147483647. The default value is 300.
weight	No	Integer	Weight of the record set. The default value is null. If weight is set to null, no weight is set for the record set. If weight is set to 0, the record set is a secondary one. If weight is larger than 0, the record set is a primary one. The value ranges from 0 to 100. For record sets with the same domain name, type, and line, the rules are as follows: - Set weights for all record sets or do not set any weight.- If no weight is set, only one record set can be created. - When a weight is set, a maximum of 20 record sets can be created.
records	Yes	Array of strings	Value of the record set. The value rules vary depending on the record set type.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
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.
recordsets	Array of QueryRecordSetWithLineResp objects	Record set list
metadata	metadata object	Number of resources that meet the query condition

**Table 6** QueryRecordSetWithLineResp
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 7** pageLink
Parameter	Type	Description
self	String	Link to the current resource
next	String	Link to the next page

**Table 8** 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 9** metadata
Parameter	Type	Description
total_count	Integer	Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

Example Requests

Modifying record sets in batches, with the TTL of the record set (ID: 2c9eb155587194ec01587224c9f9014a) set to 3600s, value to 192.168.10.1 and 192.168.10.2, and weight to 10, and the TTL of another record set (ID: 2c9eb155587194ec01587224c9f9014c) to 300s, value to fe80:0:0:0:202:b3ff:fe1e:8329 and ff03:0db8:85a3:0:0:8a2e:0370. 7334, and weight to 5

PUT https://{endpoint}/v2.1/zones/{zone_id}/recordsets

{
  "recordsets" : [ {
    "id" : "2c9eb155587194ec01587224c9f9014a",
    "description" : "This is an type A record set.",
    "ttl" : 3600,
    "weight" : 10,
    "records" : [ "192.168.10.1", "192.168.10.2" ]
  }, {
    "id" : "2c9eb155587194ec01587224c9f9014c",
    "description" : "This is an type AAAA record set.",
    "ttl" : 300,
    "weight" : 5,
    "records" : [ "fe80:0:0:0:202:b3ff:fe1e:8329", "ff03:0db8:85a3:0:0:8a2e:0370:7334" ]
  } ]
}

Example Responses

Status code: 200

Response to the request for batch modifying record sets

{
  "links" : {
    "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/batch/lines"
  },
  "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" : "PENDING_CREATE",
    "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" : "PENDING_CREATE",
    "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
  }
}