• Domain Name Service

dns
  1. Help Center
  2. Domain Name Service
  3. API Reference
  4. API Description
  5. Public Zone Management
  6. Modifying a Public Zone

Modifying a Public Zone

Function

Modify a public zone.

URI

PATCH /v2/zones/{zone_id}

For details, see Table 1.
Table 1 Parameter in the URI

Parameter

Mandatory

Type

Description

zone_id

Yes

string

ID of the zone to be modified

Request

  • Parameter description
    Table 2 Parameters in the request

    Parameter

    Mandatory

    Type

    Description

    description

    No

    string

    Description of the domain name, which cannot exceed 255 characters

    email

    No

    string

    Email address of the administrator managing the zone

    ttl

    No

    int

    Caching period of the SOA record set (in seconds)

    The default value is 300s.

    The value range is 300–2147483647.

  • Example request
    {
        "description": "This is an example zone.",
        "email": "xx@example.org",
        "ttl": 300
    }

Response

  • Parameter description
    Table 3 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, which can be public or private

    ttl

    int

    TTL value of the SOA record set in the zone

    serial

    int

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

    status

    enum

    Resource status

    The value can be PENDING_CREATEACTIVEPENDING_DELETE, or ERROR.

    record_num

    int

    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

    updated_at

    string

    Time when the zone was updated

    links

    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.

    masters

    enum

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

  • Example response
    {
        "id": "2c9eb155587194ec01587224c9f90149",
        "name": "example.com.",
        "description": "This is an example zone.",
        "email": "xx@example.com",
        "ttl": 300,
        "serial": 1,
        "masters": [],
        "status": "ACTIVE",
        "links": {
            "self": "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
        },
        "pool_id": "00000000570e54ee01570e9939b20019",
        "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
        "zone_type": "public",
        "created_at": "2016-11-17T11:56:03.439",
        "updated_at": "2016-11-17T11:56:05.749"
        "record_num": 2
    }

Returned Value

See General Request Return Code.