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 *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	dns:recordset:associatehealthcheck ces:siteMonitorRule:showHealthCheck ces:siteMonitorRule:put ces:siteMonitorRule:delete ces:siteMonitorRule:list dns:quota:list
dns:recordset:create	Write	-	dns:RecordSetNames dns:RecordSetTypes	-

URI

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

**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 header 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

**Table 3** Request body parameters
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 Public zones: The value can be A, AAAA, MX, CNAME, TXT, SRV, NS, SOA or CAA. Private zones: The value can be A, AAAA, MX, CNAME, TXT, PTR, SRV, NS or SOA. Default Value N/A
status	No	String	Definition Status of the record set Constraints N/A Range ENABLE: Resolution is enabled. DISABLE: Resolution is disabled. 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 rules vary depending on the record set type. Constraints N/A Range N/A Default Value N/A
line	No	String	Definition Resolution line ID Constraints N/A Range N/A Default Value N/A
tags	No	Array of tag objects	Definition Resource tag Constraints N/A Range N/A Default Value N/A
weight	No	Integer	Definition The weight of the record set. Constraints Alias record sets do not support weights. Range 0 to 1000 Default Value The default value for record sets of public zones is 1. The default value for record sets of private zones is null.
alias_target	No	alias_target object	Definition Domain name alias Constraints N/A Range N/A Default Value N/A

**Table 4** tag
Parameter	Mandatory	Type	Description
key	Yes	String	Definition The tag key. Range Cannot be left blank. Must be unique for each resource. Contains up to 128 characters. Cannot start or end with a space, or start with *sys*. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@
value	No	String	Definition The tag value. Range Can be left blank. Can contain a maximum of 255 characters. Only letters, digits, spaces, and the following special characters are allowed: _.:/=+-@

**Table 5** alias_target
Parameter	Mandatory	Type	Description
resource_type	No	String	Definition Services that support domain name aliases Constraints N/A Range cloudsite: Enterprise Web Portal (EWP) waf: Web Application Firewall (WAF) Default Value N/A
resource_domain_name	No	String	Definition Domain name of the target service Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 202

**Table 6** Response body parameters
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 Public zones: The value can be A, AAAA, MX, CNAME, TXT, SRV, NS, SOA or CAA. Private zones: The value can be A, AAAA, MX, CNAME, TXT, PTR, SRV, NS or SOA.
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 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 PENDING_CREATE: The zone is being created. DISABLE: The zone is disabled.
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

**Table 7** pageLink
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

**Table 8** alias_target
Parameter	Type	Description
resource_type	String	Definition Services that support domain name aliases Constraints N/A Range cloudsite: Enterprise Web Portal (EWP) waf: Web Application Firewall (WAF) 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, 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

Request accepted

{
  "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
}

Status Codes

Status Code	Description
202	Request accepted

Error Codes

See Error Codes.

Parent Topic: Record Set Management (v2.1)

Previous topic: Record Set Management (v2.1)

Next topic: Querying Record Sets in a Zone

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.