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

Modifying a Record Set

Function

This API is used to modify the information of a record set, including the domain name, type, value, TTL, and description.

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

Definition

Zone ID

Constraints

N/A

Range

N/A

Default Value

N/A

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

name

No

String

Definition

The domain name, which is a fully qualified domain name (FQDN) suffixed with a zone name, that is, a complete host name ended with a period (.).

Example: www.example.com

Constraints

N/A

Range

N/A

Default Value

N/A

description

No

String

Definition

The description of the record set.

Constraints

N/A

Range

The value can contain a maximum of 255 characters.

Default Value

This parameter is left blank by default, indicating that the original value is retained.

type

No

String

Definition

Record set type

Constraints

N/A

Range

N/A

Default Value

N/A

ttl

No

Integer

Definition

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

If your service address changes frequently, set TTL to a smaller value. Otherwise, set TTL to a larger value.

Constraints

N/A

Range

1 to 2147483647

Default Value

This parameter is left blank by default, indicating that the original value is retained.

records

No

Array of strings

Definition

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

Constraints

N/A

Range

N/A

Default Value

This parameter is left blank by default, indicating that the original value is retained.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

id

String

Definition

Record set ID

Range

N/A

name

String

Definition

Record set name

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

Zone ID of the record set

Range

N/A

zone_name

String

Definition

Zone name of the record set

Range

N/A

type

String

Definition

Record set type

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

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

Range

1 to 2147483647

records

Array of strings

Definition

Record set value

Range

N/A

create_at

String

Definition

The time when the record set was created.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

Range

N/A

update_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.

  • PENDING_CREATE: The zone is being created.

  • PENDING_UPDATE: The zone is being updated.

  • PENDING_DELETE: The zone is being deleted.

  • PENDING_FREEZE: The zone is being frozen.

  • FREEZE: The zone is frozen.

  • ILLEGAL: The zone is frozen due to abuse.

  • POLICE: The zone is frozen due to security reasons.

  • PENDING_DISABLE: The zone is being disabled.

  • DISABLE: The zone is disabled.

  • ERROR: The zone is failed.

default

Boolean

Definition

Whether the record set is created by default. A default record set cannot be deleted.

Range

N/A

project_id

String

Definition

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

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

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" : "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

Request accepted

Error Codes

See Error Codes.