Updated on 2024-10-29 GMT+08:00

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

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

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
  }
}

SDK Sample Code

The SDK sample code is as follows.

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

 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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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 BatchUpdateRecordSetWithLineSolution {

    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();
        BatchUpdateRecordSetWithLineRequest request = new BatchUpdateRecordSetWithLineRequest();
        BatchUpdateRecordSetWithLineReq body = new BatchUpdateRecordSetWithLineReq();
        List<String> listRecordsetsRecords = new ArrayList<>();
        listRecordsetsRecords.add("fe80:0:0:0:202:b3ff:fe1e:8329");
        listRecordsetsRecords.add("ff03:0db8:85a3:0:0:8a2e:0370:7334");
        List<String> listRecordsetsRecords1 = new ArrayList<>();
        listRecordsetsRecords1.add("192.168.10.1");
        listRecordsetsRecords1.add("192.168.10.2");
        List<BatchUpdateRecordSet> listbodyRecordsets = new ArrayList<>();
        listbodyRecordsets.add(
            new BatchUpdateRecordSet()
                .withId("2c9eb155587194ec01587224c9f9014a")
                .withDescription("This is an type A record set.")
                .withTtl(3600)
                .withWeight(10)
                .withRecords(listRecordsetsRecords1)
        );
        listbodyRecordsets.add(
            new BatchUpdateRecordSet()
                .withId("2c9eb155587194ec01587224c9f9014c")
                .withDescription("This is an type AAAA record set.")
                .withTtl(300)
                .withWeight(5)
                .withRecords(listRecordsetsRecords)
        );
        body.withRecordsets(listbodyRecordsets);
        request.withBody(body);
        try {
            BatchUpdateRecordSetWithLineResponse response = client.batchUpdateRecordSetWithLine(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 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

 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
# 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 = BatchUpdateRecordSetWithLineRequest()
        listRecordsRecordsets = [
            "fe80:0:0:0:202:b3ff:fe1e:8329",
            "ff03:0db8:85a3:0:0:8a2e:0370:7334"
        ]
        listRecordsRecordsets1 = [
            "192.168.10.1",
            "192.168.10.2"
        ]
        listRecordsetsbody = [
            BatchUpdateRecordSet(
                id="2c9eb155587194ec01587224c9f9014a",
                description="This is an type A record set.",
                ttl=3600,
                weight=10,
                records=listRecordsRecordsets1
            ),
            BatchUpdateRecordSet(
                id="2c9eb155587194ec01587224c9f9014c",
                description="This is an type AAAA record set.",
                ttl=300,
                weight=5,
                records=listRecordsRecordsets
            )
        ]
        request.body = BatchUpdateRecordSetWithLineReq(
            recordsets=listRecordsetsbody
        )
        response = client.batch_update_record_set_with_line(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 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

 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
58
59
60
61
62
63
64
65
66
67
68
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.BatchUpdateRecordSetWithLineRequest{}
	var listRecordsRecordsets = []string{
        "fe80:0:0:0:202:b3ff:fe1e:8329",
	    "ff03:0db8:85a3:0:0:8a2e:0370:7334",
    }
	var listRecordsRecordsets1 = []string{
        "192.168.10.1",
	    "192.168.10.2",
    }
	descriptionRecordsets:= "This is an type A record set."
	ttlRecordsets:= int32(3600)
	weightRecordsets:= int32(10)
	descriptionRecordsets1:= "This is an type AAAA record set."
	ttlRecordsets1:= int32(300)
	weightRecordsets1:= int32(5)
	var listRecordsetsbody = []model.BatchUpdateRecordSet{
        {
            Id: "2c9eb155587194ec01587224c9f9014a",
            Description: &descriptionRecordsets,
            Ttl: &ttlRecordsets,
            Weight: &weightRecordsets,
            Records: listRecordsRecordsets1,
        },
        {
            Id: "2c9eb155587194ec01587224c9f9014c",
            Description: &descriptionRecordsets1,
            Ttl: &ttlRecordsets1,
            Weight: &weightRecordsets1,
            Records: listRecordsRecordsets,
        },
    }
	request.Body = &model.BatchUpdateRecordSetWithLineReq{
		Recordsets: listRecordsetsbody,
	}
	response, err := client.BatchUpdateRecordSetWithLine(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

200

Response to the request for batch modifying record sets

Error Codes

See Error Codes.