Updated on 2024-03-20 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"
}

SDK Sample Code

The SDK sample code is as follows.

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dns.v2.region.DnsRegion;
import com.huaweicloud.sdk.dns.v2.*;
import com.huaweicloud.sdk.dns.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateRecordSetSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateRecordSetRequest request = new UpdateRecordSetRequest();
        UpdateRecordSetReq body = new UpdateRecordSetReq();
        List<String> listbodyRecords = new ArrayList<>();
        listbodyRecords.add("192.168.10.1");
        listbodyRecords.add("192.168.10.2");
        body.withRecords(listbodyRecords);
        body.withTtl(3600);
        body.withType("A");
        body.withDescription("This is an example record set.");
        body.withName("www.example.com.");
        request.withBody(body);
        try {
            UpdateRecordSetResponse response = client.updateRecordSet(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateRecordSetRequest()
        listRecordsbody = [
            "192.168.10.1",
            "192.168.10.2"
        ]
        request.body = UpdateRecordSetReq(
            records=listRecordsbody,
            ttl=3600,
            type="A",
            description="This is an example record set.",
            name="www.example.com."
        )
        response = client.update_record_set(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dns.NewDnsClient(
        dns.DnsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateRecordSetRequest{}
	var listRecordsbody = []string{
        "192.168.10.1",
	    "192.168.10.2",
    }
	ttlUpdateRecordSetReq:= int32(3600)
	descriptionUpdateRecordSetReq:= "This is an example record set."
	request.Body = &model.UpdateRecordSetReq{
		Records: &listRecordsbody,
		Ttl: &ttlUpdateRecordSetReq,
		Type: "A",
		Description: &descriptionUpdateRecordSetReq,
		Name: "www.example.com.",
	}
	response, err := client.UpdateRecordSet(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

202

Response to the request for modifying a record set

Error Codes

See Error Codes.