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

Modifying a Record Set

Function

This API is used to modify a record set.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/zones/{zone_id}/recordsets/{recordset_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

zone_id

Yes

String

Zone ID

recordset_id

Yes

String

ID of the record set to be modified

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

name

Yes

String

Fully qualified domain name (FQDN) suffixed with a zone name, which is a complete host name ended with a dot

description

No

String

(Optional) Domain name description

type

Yes

String

Record set type

ttl

No

Integer

Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect.

records

No

Array of strings

Value of the record set. The value rules vary depending on the record set type.

Response Parameters

Status code: 202

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.

  • Public zones: The type can be A, AAAA, MX, CNAME, TXT, NS, SRV or CAA.

  • Private zones: The type can be A, AAAA, MX, CNAME, TXT or SRV.

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

create_at

String

Time when the record set was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS

update_at

String

Time when the record set was updated. Format: yyyy-MM-dd'T'HH:mm:ss.SSS

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.

Example Requests

Modifying a record set, with the type set to A, TTL to 3600 seconds and value to 192.168.10.1 and 192.168.10.2

PUT https://{endpoint}/v2/zones/{zone_id}/recordsets/{recordset_id}

{
  "name" : "www.example.com.",
  "description" : "This is an example record set.",
  "type" : "A",
  "ttl" : 3600,
  "records" : [ "192.168.10.1", "192.168.10.2" ]
}

Example Responses

Status code: 202

Response to the request for modifying a 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" : "PENDING_UPDATE",
  "links" : {
    "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
  },
  "zone_id" : "2c9eb155587194ec01587224c9f90149",
  "zone_name" : "example.com.",
  "create_at" : "2016-11-17T12:03:17.827",
  "update_at" : "2016-11-17T12:56:03.827",
  "default" : false,
  "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
}

Status Codes

Status Code

Description

202

Response to the request for modifying a record set

Error Codes

See Error Codes.