Querying PTR Records of an EIP
Function
This API is used to query PTR records of an EIP.
Calling Method
For details, see Calling APIs.
URI
GET /v2/reverse/floatingips
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. This parameter is left blank by default. |
limit |
No |
Integer |
The number of records returned on each page during pagination query. The value ranges from 0 to 500. Commonly used values are 10, 20, and 50, and the default value is 500. |
offset |
No |
Integer |
The offset of pagination query. It specifies the number of rows or records to skip from the beginning of the result set before retrieving the desired data. 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 and the offset does not take effect. |
enterprise_project_id |
No |
String |
ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters. |
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
links |
pageLink object |
Definition The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page. Range N/A |
metadata |
metadata object |
Number of resources that meet the query condition. |
floatingips |
Array of ListPtrRecordsFloatingResp objects |
List of PTR record IDs of the EIP |
Parameter |
Type |
Description |
---|---|---|
total_count |
Integer |
Definition Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. Range N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
PTR record ID, which is in {region}:{floatingip_id} format |
ptrdname |
String |
The zone of the PTR record |
description |
String |
Descriptions about the PTR record |
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 address. |
status |
String |
Resource status. |
action |
String |
Requested operation on the resource. The value can be CREATE, UPDATE, DELETE, or NONE. NONE indicates that no operation will be performed. |
links |
pageLink object |
Definition The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page. Range N/A |
tags |
Array of tag objects |
Definition Resource tag Range N/A |
enterprise_project_id |
String |
ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters. |
Parameter |
Type |
Description |
---|---|---|
self |
String |
Definition The link to the current page. Range N/A |
next |
String |
Definition The link to the next page. Range N/A |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition The tag key. Range
|
value |
String |
Definition The tag value. Range
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
Example Requests
None
Example Responses
Status code: 200
Successful request
{ "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" } } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request |
400 |
Error response |
500 |
Error response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.