Updated on 2022-01-25 GMT+08:00

Creating a Private Zone

Function

Create a private zone.

URI

POST /v2/zones

Request

  • Parameter description
    Table 1 Parameters in the request

    Parameter

    Mandatory

    Type

    Description

    name

    Yes

    String

    Domain name of the zone to be created

    • If a domain name is ended with a dot (.), it cannot exceed 254 characters.
    • Otherwise, the domain name cannot exceed 253 characters.
    • Labels of a domain name are separated by dot (.). Each label cannot exceed 63 characters.

    A domain name is case insensitive. Uppercase letters will also be converted into lowercase letters.

    description

    No

    String

    Description of the domain name, which cannot exceed 255 characters

    The value is left blank by default.

    zone_type

    Yes

    String

    Zone type

    The value must be private, indicating private zones accessible only to hosts in specified VPCs will be created.

    email

    No

    String

    Email address of the administrator managing the zone

    The default value is the service email address.

    ttl

    No

    Integer

    Caching period of the SOA record set (in seconds)

    The value ranges from 1 to 2147483647.

    The default value is 300.

    router

    Yes

    Object

    Router information (VPC associated with the private zone)

    For details, see Table 2.

    tags

    No

    Array of object

    Resource tag. For details, see Table 3.

    The value is left blank by default.

    enterprise_project_id

    No

    String

    ID of the enterprise project associated with the public zone. The value contains a maximum of 36 characters.

    The default value is 0.

    Table 2 Description of the router field

    Parameter

    Mandatory

    Type

    Description

    router_id

    Yes

    String

    ID of the associated VPC

    router_region

    No

    String

    Region of the VPC

    If it is left blank, the region of the project in the token takes effect by default.

    Table 3 Description of the tags field

    Parameter

    Mandatory

    Type

    Description

    key

    Yes

    String

    Tag key. The key contains 36 Unicode characters at most and cannot be blank. It cannot contain the following characters: =*<>\,|/ nor start or end with a space.

    value

    No

    String

    Tag value. Each value contains 43 Unicode characters at most and can be an empty string. It cannot contain the following characters: =*<>\,|/ nor start or end with a space.

  • Example request
    Create a private zone named example.com.
    POST https://{DNS_Endpoint}/v2/zones
    {
        "name": "example.com.",
        "description": "This is an example zone.",
        "zone_type": "private",
        "email": "xx@example.org",
        "router": {
            "router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
            "router_region": "xx"
        },
        "tags": [
            {
              "key": "key1",
              "value": "value1"
            }
        ]
    }

Response

  • Parameter description
    Table 4 Parameters in the response

    Parameter

    Type

    Description

    id

    String

    Zone ID, which is a UUID used to identify the zone

    name

    String

    Zone name

    description

    String

    Zone description

    email

    String

    Email address of the administrator managing the zone

    zone_type

    String

    Zone type. The value is private.

    ttl

    Integer

    TTL value of the SOA record set in the zone

    serial

    Integer

    Serial number in the SOA record set in a zone, which identifies the change on the primary DNS server

    This parameter is not used currently.

    status

    String

    Resource status

    For details, see Resource Status.

    record_num

    Integer

    Number of record sets in the zone

    pool_id

    String

    Pool ID of the zone, which is assigned by the system

    project_id

    String

    Project ID of the zone

    created_at

    String

    Time when the zone was created

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    updated_at

    String

    Time when the zone was updated

    The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.

    links

    Object

    Link to the current resource or other related resources.

    When a response is broken into pages, a next link is provided to retrieve all results.

    For details, see Table 5.

    masters

    Array of strings

    Master DNS servers, from which the slave servers get DNS information

    This parameter is not used currently.

    router

    Object

    Information about the VPC associated with the zone. For details, see Table 6.

    Table 5 Parameters in the links field

    Parameter

    Type

    Description

    self

    String

    Link to the current resource

    next

    String

    Link to the next page

    Table 6 Description of the router field

    Parameter

    Type

    Description

    status

    String

    Resource status

    For details, see Resource Status.

    router_id

    String

    Router ID (VPC ID)

    router_region

    String

    Region of the VPC

  • Example response
    {
        "id": "ff8080825b8fc86c015b94bc6f8712c3",
        "name": "example.com.",
        "description": "This is an example zone.",
        "email": "xx@example.com",
        "ttl": 300,
        "serial": 1,
        "masters": [],
        "status": "PENDING_CREATE",
        "links": {
            "self": "https://Endpoint/v2/zones/ff8080825b8fc86c015b94bc6f8712c3"
        },
        "pool_id": "ff8080825ab738f4015ab7513298010e",
        "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
        "zone_type": "private",
        "created_at": "2017-04-22T08:17:08.997",
        "updated_at": null,
        "record_num": 0,
        "router": {
            "status": "PENDING_CREATE",
            "router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
            "router_region": "xx"
        }
    }
    

Returned Value

If a 2xx status code is returned, for example, 200, 202, or 204, the request is successful.

For details, see Status Code.