Creating a Record Set

Function

This API is used to create a record set.

Calling Method

For details, see Calling APIs.

URI

POST /v2/zones/{zone_id}/recordsets

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
zone_id	Yes	String	Zone ID

Request Parameters

**Table 2** Request header 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.

**Table 3** Request body parameters
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 dot
description	No	String	(Optional) Description of the domain name. The description contains no more than 255 characters. It is left blank by default.
type	Yes	String	Record set type. Public zones: The type can be A, AAAA, MX, CNAME, TXT, NS, SRV or CAA. Private zones: The value can be A, AAAA, MX, CNAME, TXT or SRV.
status	No	String	Resource status
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. If your service address changes frequently, set TTL to a smaller value.
records	Yes	Array of strings	Value of the record set. The value rules vary depending on the record set type.
tags	No	Array of tag objects	Specifies the resource tag.

**Table 4** tag
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

**Table 5** Response body parameters
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. Public zones: The type can be A, AAAA, MX, CNAME, TXT, NS, SRV or CAA. Private zones: The value can be A, AAAA, MX, CNAME, TXT or SRV.
ttl	Integer	Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect. If your service address changes frequently, set TTL to a smaller value.
records	Array of strings	Record set value
create_at	String	Time when the record set was created. Format: yyyy-MM-dd'T'HH:mm:ss.SSS
update_at	String	Time when the record set was updated. Format: yyyy-MM-dd'T'HH:mm:ss.SSS
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.

**Table 6** pageLink
Parameter	Type	Description
self	String	Link to the current resource
next	String	Link to the next page

Example Requests

Creating an A record set, with its TTL set to 3600s, value to 192.168.10.1 and 192.168.10.2

POST https://{endpoint}/v2/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" ],
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  } ]
}

Example Responses

Status code: 202

Response for creating a record set

{
  "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/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
  },
  "zone_id" : "2c9eb155587194ec01587224c9f90149",
  "zone_name" : "example.com.",
  "create_at" : "2016-11-17T12:03:17.827",
  "update_at" : null,
  "default" : false,
  "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
}