更新时间:2024-12-19 GMT+08:00

批量线路创建RecordSet

功能介绍

批量线路创建RecordSet。属于原子性操作,如果存在一个参数校验不通过,则创建失败。仅公网Zone支持。

调用方法

请参见如何调用API

URI

POST /v2.1/zones/{zone_id}/recordsets/batch/lines

表1 路径参数

参数

是否必选

参数类型

描述

zone_id

String

所属Zone的ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

后缀需以Zone Name结束且为FQDN(即以“.”号结束的完整主机名)。

description

String

可选配置,对域名的描述。 长度不超过255个字符。

type

String

Record Set的类型。 取值范围:A,AAAA,MX,CNAME,TXT,NS,SRV,CAA。

lines

Array of batchCreateRecordSetWithLine objects

解析线路域名参数。最多支持50个。

表4 batchCreateRecordSetWithLine

参数

是否必选

参数类型

描述

line

String

解析线路ID。

ttl

Integer

Record Set的有效缓存时间,以秒为单位。 取值范围:300-2147483647。 默认值为300s。

weight

Integer

解析记录的权重,默认为1。 当weight=null时,表示该解析记录不设置权重。 当weight=0,表示备用域名解析记录。 当weight>0,表示主用域名解析记录。 取值范围:0~100 在相同域名、类型、线路下的解析记录,规则如下: 全部设置权重,或全部不设置权重。 当不设置权重时,只能创建一个解析记录。 当设置权重时,最多能创建20个解析记录。

records

Array of strings

解析记录的值。不同类型解析记录对应的值的规则不同。

响应参数

状态码: 202

表5 响应Body参数

参数

参数类型

描述

links

pageLink object

指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。

recordsets

Array of QueryRecordSetWithLineResp objects

recordset的列表信息。

metadata

metadata object

返回满足过滤条件的资源总数。

表6 QueryRecordSetWithLineResp

参数

参数类型

描述

id

String

Record Set的ID。

name

String

Record Set的名称。

description

String

Record Set的描述信息。

zone_id

String

托管该记录的zone_id。

zone_name

String

托管该记录的zone_name。

type

String

记录类型。

ttl

Integer

解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。

records

Array of strings

域名解析后的值。

created_at

String

创建时间。

updated_at

String

更新时间。

status

String

资源状态。

default

Boolean

标识是否由系统默认生成,系统默认生成的Record Set不能删除。

project_id

String

该Record Set所属的项目ID。

links

pageLink object

指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。

line

String

解析线路ID。

weight

Integer

解析记录的权重。

health_check_id

String

健康检查ID。

alias_target

alias_target object

别名记录。

bundle

String

规格,默认规格,保留字段。

表8 alias_target

参数

参数类型

描述

resource_type

String

资源服务类型,支持别名记录的服务。取值: cloudsite:云速建站 waf:Web应用防火墙

resource_domain_name

String

对应服务下的域名,由各服务提供。

表9 metadata

参数

参数类型

描述

total_count

Integer

满足查询条件的资源总数,不受分页(即limit、offset参数)影响。

请求示例

批量线路创建A类型记录集,设置线路类型为“default_view”,解析记录值为"3.3.3.3",TTL为300秒,权重为1。

POST https://{endpoint}/zones/{zone_id}/recordsets/batch/lines

{
  "name" : "www.example.com.",
  "description" : "This is an example record set.",
  "type" : "A",
  "lines" : [ {
    "line" : "default_view",
    "records" : [ "3.3.3.3" ],
    "ttl" : 300,
    "weight" : 1
  } ]
}

响应示例

状态码: 202

{
  "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代码示例

SDK代码示例如下。

批量线路创建A类型记录集,设置线路类型为“default_view”,解析记录值为"3.3.3.3",TTL为300秒,权重为1。

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

    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();
        CreateRecordSetWithBatchLinesRequest request = new CreateRecordSetWithBatchLinesRequest();
        request.withZoneId("{zone_id}");
        CreateRSetBatchLinesReq body = new CreateRSetBatchLinesReq();
        List<String> listLinesRecords = new ArrayList<>();
        listLinesRecords.add("3.3.3.3");
        List<BatchCreateRecordSetWithLine> listbodyLines = new ArrayList<>();
        listbodyLines.add(
            new BatchCreateRecordSetWithLine()
                .withLine("default_view")
                .withTtl(300)
                .withWeight(1)
                .withRecords(listLinesRecords)
        );
        body.withLines(listbodyLines);
        body.withType("A");
        body.withDescription("This is an example record set.");
        body.withName("www.example.com.");
        request.withBody(body);
        try {
            CreateRecordSetWithBatchLinesResponse response = client.createRecordSetWithBatchLines(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());
        }
    }
}

批量线路创建A类型记录集,设置线路类型为“default_view”,解析记录值为"3.3.3.3",TTL为300秒,权重为1。

 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
# 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 = CreateRecordSetWithBatchLinesRequest()
        request.zone_id = "{zone_id}"
        listRecordsLines = [
            "3.3.3.3"
        ]
        listLinesbody = [
            BatchCreateRecordSetWithLine(
                line="default_view",
                ttl=300,
                weight=1,
                records=listRecordsLines
            )
        ]
        request.body = CreateRSetBatchLinesReq(
            lines=listLinesbody,
            type="A",
            description="This is an example record set.",
            name="www.example.com."
        )
        response = client.create_record_set_with_batch_lines(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

批量线路创建A类型记录集,设置线路类型为“default_view”,解析记录值为"3.3.3.3",TTL为300秒,权重为1。

 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
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.CreateRecordSetWithBatchLinesRequest{}
	request.ZoneId = "{zone_id}"
	var listRecordsLines = []string{
        "3.3.3.3",
    }
	ttlLines:= int32(300)
	weightLines:= int32(1)
	var listLinesbody = []model.BatchCreateRecordSetWithLine{
        {
            Line: "default_view",
            Ttl: &ttlLines,
            Weight: &weightLines,
            Records: listRecordsLines,
        },
    }
	descriptionCreateRSetBatchLinesReq:= "This is an example record set."
	request.Body = &model.CreateRSetBatchLinesReq{
		Lines: listLinesbody,
		Type: "A",
		Description: &descriptionCreateRSetBatchLinesReq,
		Name: "www.example.com.",
	}
	response, err := client.CreateRecordSetWithBatchLines(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

202

批量线路创建RecordSet响应

错误码

请参见错误码