Creating a Record Set
Function
This API is used to create a record set. This API applies only to public zones.
Calling Method
For details, see Calling APIs.
URI
POST /v2.1/zones/{zone_id}/recordsets
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
zone_id |
Yes |
String |
Zone ID |
Request 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. |
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 period |
description |
No |
String |
(Optional) Domain name description |
type |
Yes |
String |
Record set type |
status |
No |
String |
Record set status. The value can be ENABLE or DISABLE, and the default value is ENABLE. ENABLE means that the record set is enabled. DISABLE means that the record set is disabled. |
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. |
line |
No |
String |
Resolution line ID |
tags |
No |
Array of tag objects |
Resource Tag |
weight |
No |
Integer |
Weight of the record set |
alias_target |
No |
alias_target object |
Domain name alias |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Tag key. A key can contain up to 36 Unicode characters. It cannot be left blank. A tag value cannot contain special characters (=*<>,|/) or start or end with spaces. |
value |
No |
String |
Tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. A tag value cannot contain special characters (=*<>,|/) or start or end with spaces. |
Response Parameters
Status code: 202
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. The type can be A, AAAA, MX, CNAME, TXT, NS, SRV, or CAA. |
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 |
Example Requests
Creating an A record set, with the TTL set to 3600s, line type to default_view, value to 192.168.10.1 and 192.168.10.2, and weight to 1
POST https://{endpoint}/v2.1/zones/{zone_id}/recordsets { "name" : "www.example.com.", "description" : "This is an example record set.", "type" : "A", "ttl" : 3600, "records" : [ "192.168.10.1", "192.168.10.2" ], "line" : "default_view", "weight" : 1, "tags" : [ { "key" : "key1", "value" : "value1" } ] }
Example Responses
Status code: 202
{ "id" : "2c9eb155587228570158722b6ac30007", "name" : "www.example.com.", "description" : "This is an example record set.", "type" : "A", "ttl" : 300, "records" : [ "192.168.10.1", "192.168.10.2" ], "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, "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null }
SDK Sample Code
The SDK sample code is as follows.
Creating an A record set, with the TTL set to 3600s, line type to default_view, value to 192.168.10.1 and 192.168.10.2, 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 65 66 67 |
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 CreateRecordSetWithLineSolution { 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(); CreateRecordSetWithLineRequest request = new CreateRecordSetWithLineRequest(); request.withZoneId("{zone_id}"); CreateRecordSetWithLineRequestBody body = new CreateRecordSetWithLineRequestBody(); List<Tag> listbodyTags = new ArrayList<>(); listbodyTags.add( new Tag() .withKey("key1") .withValue("value1") ); List<String> listbodyRecords = new ArrayList<>(); listbodyRecords.add("192.168.10.1"); listbodyRecords.add("192.168.10.2"); body.withWeight(1); body.withTags(listbodyTags); body.withLine("default_view"); 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 { CreateRecordSetWithLineResponse response = client.createRecordSetWithLine(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, with the TTL set to 3600s, line type to default_view, value to 192.168.10.1 and 192.168.10.2, 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 |
# 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 = CreateRecordSetWithLineRequest() request.zone_id = "{zone_id}" listTagsbody = [ Tag( key="key1", value="value1" ) ] listRecordsbody = [ "192.168.10.1", "192.168.10.2" ] request.body = CreateRecordSetWithLineRequestBody( weight=1, tags=listTagsbody, line="default_view", records=listRecordsbody, ttl=3600, type="A", description="This is an example record set.", name="www.example.com." ) response = client.create_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) |
Creating an A record set, with the TTL set to 3600s, line type to default_view, value to 192.168.10.1 and 192.168.10.2, 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 |
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.CreateRecordSetWithLineRequest{} request.ZoneId = "{zone_id}" valueTags:= "value1" var listTagsbody = []model.Tag{ { Key: "key1", Value: &valueTags, }, } var listRecordsbody = []string{ "192.168.10.1", "192.168.10.2", } weightCreateRecordSetWithLineRequestBody:= int32(1) lineCreateRecordSetWithLineRequestBody:= "default_view" ttlCreateRecordSetWithLineRequestBody:= int32(3600) descriptionCreateRecordSetWithLineRequestBody:= "This is an example record set." request.Body = &model.CreateRecordSetWithLineRequestBody{ Weight: &weightCreateRecordSetWithLineRequestBody, Tags: &listTagsbody, Line: &lineCreateRecordSetWithLineRequestBody, Records: &listRecordsbody, Ttl: &ttlCreateRecordSetWithLineRequestBody, Type: "A", Description: &descriptionCreateRecordSetWithLineRequestBody, Name: "www.example.com.", } response, err := client.CreateRecordSetWithLine(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 creating a record set |
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