Updated on 2025-11-17 GMT+08:00

Batch Creating Record Sets

Function

This API is used to submit the task for batch creating record sets and return the task ID.

Constraints

Both public and private zones are supported.

A maximum of 2,000 record sets are supported per task.

A zone can have only one task.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v2.1/zones/{zone_id}/recordsets/batch-create-task

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

recordsets

Yes

Array of BatchCreateRecordSetsTaskItem objects

List of record sets to be created in a batch.

Table 3 BatchCreateRecordSetsTaskItem

Parameter

Mandatory

Type

Description

name

No

String

Definition

Record set name or domain name.

If the domain name ends with a dot (.), it is considered as a complete domain name. If the domain name does not contain a dot (.), it is considered as a domain name prefix. For example:

If you enter www for Name, the domain name is www.example.com.

If you enter www.example.com. (a domain name with a period at the end) for Name, the domain name is www.example.com.

If you enter www.example.com (a domain name without a period at the end) for Name, the domain name is www.example.com.example.com.

Constraints

N/A

Range

N/A

Default Value

N/A

type

Yes

String

Definition

Record set type.

Constraints

N/A

Range

  • Record set types of public zones include A, CNAME, MX, AAAA, TXT, SRV, NS, CAA, REDIRECT_URL, and FORWARD_URL.

  • Record set types of private zones include A, CNAME, MX, AAAA, TXT, SRV, and PTR.

Default Value

N/A

line

No

String

Definition

Resolution line ID.

Constraints

N/A

Range

N/A

Default Value

N/A

ttl

No

Integer

Definition

How long a local DNS server caches a DNS record. It is measured in seconds. Longer TTLs reduce queries but delay updates.

Constraints

N/A

Range

1 to 2147483647

Default Value

300

weight

No

Integer

Definition

Weight of the record set.

Constraints

MX record sets do not support weights. When you create an MX record set, ignore the Weight field. If your MX record set has multiple values, enter multiple values. (If there are multiple MX records with the same name and line, they will be automatically combined into one record set.)

Range

0 to 1000

Default Value

N/A

records

Yes

Array of strings

Definition

Value of the record set. The values vary depending on the record set type.

Constraints

N/A

Range

N/A

Default Value

N/A

status

No

String

Definition

The status of the record set.

Constraints

N/A

Range

  • ENABLE

  • DISABLE

Default Value

ENABLE

description

No

String

Definition

The description of the record set.

Constraints

N/A

Range

Maximum length: 255 characters.

Default Value

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

task_id

String

Definition

ID of the task for batch creating record sets.

Range

N/A

Example Requests

Batch creating record sets

POST https://{endpoint}/v2.1/zones/{zone_id}/recordsets/batch-create-task

{
  "recordsets" : [ {
    "name" : "www.example.com.",
    "type" : "A",
    "line" : "default_view",
    "ttl" : 300,
    "weight" : 1,
    "records" : [ "192.168.10.1", "192.168.10.2" ],
    "status" : "ENABLE",
    "description" : "This is an example record set."
  } ]
}

Example Responses

Status code: 202

Batch creating record sets

{
  "task_id" : "9a186e66977dd48f01977e021c480cac"
}

SDK Sample Code

The SDK sample code is as follows.

Batch creating record sets

 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
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 BatchCreateRecordSetsTaskSolution {

    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();
        BatchCreateRecordSetsTaskRequest request = new BatchCreateRecordSetsTaskRequest();
        request.withZoneId("{zone_id}");
        BatchCreateRecordSetsTaskRequestBody body = new BatchCreateRecordSetsTaskRequestBody();
        List<String> listRecordsetsRecords = new ArrayList<>();
        listRecordsetsRecords.add("192.168.10.1");
        listRecordsetsRecords.add("192.168.10.2");
        List<BatchCreateRecordSetsTaskItem> listbodyRecordsets = new ArrayList<>();
        listbodyRecordsets.add(
            new BatchCreateRecordSetsTaskItem()
                .withName("www.example.com.")
                .withType("A")
                .withLine("default_view")
                .withTtl(300)
                .withWeight(1)
                .withRecords(listRecordsetsRecords)
                .withStatus("ENABLE")
                .withDescription("This is an example record set.")
        );
        body.withRecordsets(listbodyRecordsets);
        request.withBody(body);
        try {
            BatchCreateRecordSetsTaskResponse response = client.batchCreateRecordSetsTask(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());
        }
    }
}

Batch creating record sets

 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
# coding: utf-8

import os
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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = BatchCreateRecordSetsTaskRequest()
        request.zone_id = "{zone_id}"
        listRecordsRecordsets = [
            "192.168.10.1",
            "192.168.10.2"
        ]
        listRecordsetsbody = [
            BatchCreateRecordSetsTaskItem(
                name="www.example.com.",
                type="A",
                line="default_view",
                ttl=300,
                weight=1,
                records=listRecordsRecordsets,
                status="ENABLE",
                description="This is an example record set."
            )
        ]
        request.body = BatchCreateRecordSetsTaskRequestBody(
            recordsets=listRecordsetsbody
        )
        response = client.batch_create_record_sets_task(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Batch creating record sets

 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
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.BatchCreateRecordSetsTaskRequest{}
	request.ZoneId = "{zone_id}"
	var listRecordsRecordsets = []string{
        "192.168.10.1",
	    "192.168.10.2",
    }
	nameRecordsets:= "www.example.com."
	lineRecordsets:= "default_view"
	ttlRecordsets:= int32(300)
	weightRecordsets:= int32(1)
	statusRecordsets:= "ENABLE"
	descriptionRecordsets:= "This is an example record set."
	var listRecordsetsbody = []model.BatchCreateRecordSetsTaskItem{
        {
            Name: &nameRecordsets,
            Type: "A",
            Line: &lineRecordsets,
            Ttl: &ttlRecordsets,
            Weight: &weightRecordsets,
            Records: listRecordsRecordsets,
            Status: &statusRecordsets,
            Description: &descriptionRecordsets,
        },
    }
	request.Body = &model.BatchCreateRecordSetsTaskRequestBody{
		Recordsets: listRecordsetsbody,
	}
	response, err := client.BatchCreateRecordSetsTask(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

Batch creating record sets

Error Codes

See Error Codes.