Creating a Record Set
Function
This API is used to add record sets of different types to a zone.
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, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
dns:recordset:create
Write
zone *
-
- dns:recordset:associatehealthcheck
- ces:siteMonitorRule:showHealthCheck
- ces:siteMonitorRule:put
- ces:siteMonitorRule:delete
- ces:siteMonitorRule:list
- dns:quota:list
-
URI
POST /v2.1/zones/{zone_id}/recordsets
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| zone_id | Yes | String | Definition Zone ID. You can obtain the ID by calling the API for querying public zones (ListPublicZones) or for querying private zones (ListPrivateZones). Constraints N/A Range N/A Default Value N/A |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token, which is used for identity authentication. It must be carried in the request header to verify the user identity during API calls. You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, see Obtaining 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
Default Value N/A |
| status | No | String | Definition Status of the record set Constraints N/A Range Default Value ENABLE |
| ttl | No | Integer | Definition The TTL of the record set in the local DNS server. It is measured in seconds. Longer TTLs reduce queries but delay updates. Constraints N/A Range 1 to 2147483647 Default Value 300 |
| records | No | Array of strings | Definition Value of the record set. The value varies depending on the record set type. This field is a string array. Each element is the value of a record set. Constraints N/A |
| line | No | String | Definition Resolution line ID. For details about how to obtain the line ID, see Resolution Lines. Alternatively, you can obtain the line ID by calling the API for querying custom lines (ListCustomLine) or the API for querying the line groups (ListLineGroups). Constraints N/A Range N/A Default Value N/A |
| tags | No | Array of tagReq objects | Definition Resource tags. The value is an array. Each element contains a tag key and tag value, which are used to manage and filter resource tags. Constraints You can add up to 20 tags. |
| weight | No | Integer | Definition The weight of the record set. Constraints Alias record sets do not support weights. Range 0 to 1000 Default Value |
| alias_target | No | AliasTargetReq object | Definition Domain name alias, which is used to point the current record set to the domain name of another cloud service. Constraints N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| key | Yes | String | Definition Tag key. Constraints Range Default Value N/A |
| value | No | String | Definition Tag value. Constraints Range Default Value N/A |
Response Parameters
Status code: 202
| 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 will be applied. Range 1 to 2147483647 |
| records | Array of strings | Definition Record set value. This field is a string array. Each element is the value of a record set. |
| created_at | String | Definition The time when the record set was created. The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000. Range N/A |
| updated_at | String | Definition The time when the record set was last modified. The value must be a UTC+0 time in format of yyyy-MM-dd'T'HH:mm:ss.SSS, for example, 2023-01-01T12:00:00.000. 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 |
| project_id | String | Definition ID of the project to which the record set belongs Range N/A |
| links | pageLink object | Definition Links to the current page and the next page. If pagination is required for querying resources, a next field is required to point to the next page. |
| 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. |
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" : 3600,
"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 62 63 64 65 66 67 68 69 70 71 72 73 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dns.DnsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dns.NewDnsClient(hcClient) 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 | Request accepted |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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