Deleting a Record Set

Function

Delete a record set.

URI

DELETE /v2/zones/{zone_id}/recordsets/{recordset_id}

For details, see Table 1.

Table 1 Parameters in the URI

Parameter	Mandatory	Type	Description
zone_id	Yes	String	Zone ID Obtain the public zone ID according to Querying Public Zones. Obtain the private zone ID according to Querying Private Zones.
recordset_id	Yes	String	ID of the record set to be deleted You can obtain the value by calling the API in Querying Record Sets in a Zone.

Request

• Request parameters

  None

• Example request

  Delete the record set whose ID is 2c9eb155587228570158722b6ac30007 in the zone whose ID is 2c9eb155587194ec01587224c9f90149:

  DELETE https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007
  

Response

• Parameter description

  Table 2 Parameters in the response

  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 (only in public zones), SRV, CAA (only in public zones), and PTR (only in private zones). For details, see Record Set Type.
  ttl	Integer	Record set cache duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect. If your service address is frequently changed, set TTL to a smaller value. Value range: Public zone: 1-2147483647 Private zone: 1-2147483647 The default value is 300.
  records	Array of strings	Record set value
  create_at	String	Time when the record set was created The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.
  update_at	String	Time when the record set was updated The value format is yyyy-MM-dd'T'HH:mm:ss.SSS.
  status	String	Resource status For details, see Resource Status.
  default	Boolean	Whether the record set is created by default. A default record set cannot be deleted.
  project_id	String	Project ID of the record set
  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.

  Table 3 Parameters in the links field

  Parameter	Type	Description
  self	String	Link to the current resource
  next	String	Link to the next page

• Example response

  {
      "id": "2c9eb155587228570158722b6ac30007",
      "name": "www.example.com.",
      "description": "This is an example record set.",
      "type": "A",
      "ttl": 300,
      "status": "PENDING_DELETE",
      "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": "2016-11-17T12:56:03.827",
      "default": false,
      "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
  }
  

Returned Value

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

For details, see Status Code.

last updated: 2024-12-11 10:03 UTC - commit: 1d12e1510a9f436f2cf19153de0b2d03d692f4fe