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

**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) Domain name description
type	Yes	String	Record set type
status	No	String	Status of the record set. The default value is ENABLE.
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

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

**Table 5** alias_target
Parameter	Mandatory	Type	Description
resource_type	No	String	Service that supports domain name aliases. Value options: cloudsite: CloudSite waf: Web Application Firewall
resource_domain_name	No	String	Domain name of the target service

Response Parameters

Status code: 200

**Table 6** 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. The value 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

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

**Table 8** alias_target
Parameter	Type	Description
resource_type	String	Service that supports domain name aliases. Value options: cloudsite: CloudSite waf: Web Application Firewall
resource_domain_name	String	Domain name of the target service

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: 200

Response to the request 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.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
}