Batch Creating Record Sets with Lines
Function
This API is used to batch create record sets with lines. This operation is an atomic operation. If any parameter fails to pass the verification, the creation fails. Only public zones are supported.
Calling Method
For details, see Calling APIs.
URI
POST /v2.1/zones/{zone_id}/recordsets/batch/lines
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
zone_id |
Yes |
String |
Definition Zone ID Constraints N/A Range N/A Default Value N/A |
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
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 N/A |
type |
Yes |
String |
Definition Record set type Constraints N/A Range A, AAAA, MX, CNAME, TXT, SRV, NS, SOA, or CAA Default Value N/A |
lines |
Yes |
Array of batchCreateRecordSetWithLine objects |
Definition Resolution line Constraints You can specify a maximum of 50 lines. Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
line |
Yes |
String |
Definition Resolution line ID Constraints N/A Range N/A Default Value N/A |
ttl |
No |
Integer |
Definition The TTL of the record set. It is measured in seconds. Constraints N/A Range 1 to 2147483647 Default Value 300 |
weight |
No |
Integer |
Definition Weight of the record set Constraints Rules for setting weights for record sets with the same name, type, and line are as follows:
Range 0 to 1000
Default Value 1 |
records |
Yes |
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 N/A |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
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 |
recordsets |
Array of QueryRecordSetWithLineResp objects |
Definition Record set list Range N/A |
metadata |
metadata object |
Definition Number of resources that meet the filter condition Range N/A |
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
|
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 |
created_at |
String |
Definition The time when the record set was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS Range N/A |
updated_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
|
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 |
line |
String |
Definition Resolution line ID Range N/A |
weight |
Integer |
Definition Weight of the record set Range 0 to 1000 |
health_check_id |
String |
Definition Health check ID Range N/A |
alias_target |
alias_target object |
Definition Domain name alias Range N/A |
bundle |
String |
Definition Specification, which is the default specification. This field is reserved. Range N/A |
Parameter |
Type |
Description |
---|---|---|
self |
String |
Definition The link to the current page. Range N/A |
next |
String |
Definition The link to the next page. Range N/A |
Parameter |
Type |
Description |
---|---|---|
resource_type |
String |
Definition Services that support domain name aliases Constraints N/A Range
Default Value N/A |
resource_domain_name |
String |
Definition Domain name of the target service Constraints N/A Range N/A Default Value N/A |
Example Requests
Creating an A record set for multiple lines, with the line type set to default_view, record set value to 3.3.3.3, TTL to 300s, and weight to 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 } ] }
Example Responses
Status code: 202
Request accepted
{ "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.
Creating an A record set for multiple lines, with the line type set to default_view, record set value to 3.3.3.3, TTL to 300s, and weight to 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()); } } } |
Creating an A record set for multiple lines, with the line type set to default_view, record set value to 3.3.3.3, TTL to 300s, and weight to 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) |
Creating an A record set for multiple lines, with the line type set to default_view, record set value to 3.3.3.3, TTL to 300s, and weight to 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) } } |
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 |
Request accepted |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot