Qin Ying, Fan a79d5bdbdb DNS API 1017 version

Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>

2022-10-20 13:26:00 +00:00

18 KiB

Raw Permalink Blame History

Deleting a Public Zone

Function

Delete a public zone.

URI

DELETE /v2/zones/{zone_id}

For details, see Table 1.

**Table 1** Parameter in the URI
Parameter	Mandatory	Type	Description
zone_id	Yes	String	Zone ID You can obtain the value by calling the API in Querying Public Zones.

Request

Request parameters
None
Example request
Delete the zone whose ID is 2c9eb155587194ec01587224c9f90149:
```
DELETE https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149
```

Response

Parameter description

**Table 2** 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	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 3.
masters	Array of strings	Master DNS servers, from which the slave servers get DNS information This parameter is not used currently.

**Table 3** Description of the **links** field
Parameter	Type	Description
self	String	Link to the current resource
next	String	Link to the next page

Example response

{
    "id": "2c9eb155587194ec01587224c9f90149",
    "name": "example.com.",
    "description": "This is an example zone.",
    "email": "xx@example.com",
    "ttl": 300,
    "serial": 1,
    "masters": [],
    "status": "PENDING_DELETE",
    "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.057",
    "record_num": 0
}

Returned Value

If the API call returns a code of 2xx, for example, 200, 202, or 204, the request is successful.

For details, see Status Code.

Parent topic: Public Zone Management

18 KiB Raw Permalink Blame History