Querying PTR Records

Updated on 2024-03-25 GMT+08:00

View PDF

Function

This API is used to query all the PTR records.

Calling Method

For details, see Calling APIs.

URI

GET /v2/reverse/floatingips

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. It is left blank by default.
limit	No	Integer	Number of resources on each page. The value ranges from 0 to 500. Commonly used values are 10, 20, and 50. The default value is 500.
offset	No	Integer	Start offset of pagination query. The query will start from the next resource of the offset value. The value ranges from 0 to 2147483647. The default value is 0. If marker is not left blank, the query starts from the resource specified by marker.
enterprise_project_id	No	String	ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters. Default value: 0
tags	No	String	Resource tag. The format is as follows: key1,value1\|key2,value2. Multiple tags are separated by vertical bar (\|). The key and value of each tag are separated by comma (,).
status	No	String	Resource status

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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
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.
metadata	metadata object	Number of resources that meet the query condition
floatingips	Array of ListPtrRecordsFloatingResp objects	PTR record ID list of an EIP

**Table 4** metadata
Parameter	Type	Description
total_count	Integer	Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

**Table 5** ListPtrRecordsFloatingResp
Parameter	Type	Description
id	String	PTR record ID, which is in {region}:{floatingip_id} format
ptrdname	String	Domain name of the PTR record
description	String	PTR record description
ttl	Integer	PTR record caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect.
address	String	EIP
status	String	Resource status
action	String	Requested operation on the resource.Value options: CREATE, UPDATE, DELETE, NONE, CREATE, UPDATE, and DELETENONE: No operation will be performed.
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.
tags	Array of tag objects	Resource tag
enterprise_project_id	String	ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters.

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

**Table 7** tag
Parameter	Type	Description
key	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	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.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Error code Minimum: 8 Maximum: 36
message	String	Description Minimum: 2 Maximum: 512

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
code	String	Error code Minimum: 8 Maximum: 36
message	String	Description Minimum: 2 Maximum: 512

Example Requests

None

Example Responses

Status code: 200

Response to the request for querying the PTR record list

{
  "links" : {
    "self" : "https://Endpoint/v2/reverse/floatingips",
    "next" : "https://Endpoint/v2/zones?id=&limit=10&marker=region_id:c5504932-bf23-4171-b655-b87a6bc59334"
  },
  "metadata" : {
    "total_count" : 1
  },
  "floatingips" : [ {
    "id" : "region_id:c5504932-bf23-4171-b655-b87a6bc59334",
    "ptrdname" : "www.example.com.",
    "description" : "Description for this PTR record",
    "address" : "10.154.52.138",
    "action" : "NONE",
    "ttl" : 300,
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/reverse/floatingips/region_id:c5504932-bf23-4171-b655-b87a6bc59334"
    }
  } ]
}