Updated on 2025-08-19 GMT+08:00

Querying a PTR Record of an EIP

Function

This API is used to query a PTR record of an EIP.

Calling Method

For details, see Calling APIs.

URI

GET /v2.1/ptrs/{ptr_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

ptr_id

Yes

String

PTR record ID

Request Parameters

Table 2 Request header 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

Table 3 Response body parameters

Parameter

Type

Description

publicip

PublicIpRes object

EIP

ptrdnames

Array of strings

List of domain names of the PTR record. A maximum of 10 domain names are allowed.

id

String

PTR record ID

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.

status

String

Resource status

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

enterprise_project_id

String

ID of the enterprise project associated with the PTR record. The value can contain a maximum of 36 characters.

Table 4 PublicIpRes

Parameter

Type

Description

region

String

Region to which the EIP belongs

id

String

EIP ID

address

String

EIP

Example Requests

Querying a PTR Record of an EIP

GET https://{endpoint}/v2.1/ptrs/9a175b97889f2f3501889fa3a8a66ed0

Example Responses

Status code: 200

Successful request

{
  "publicip" : {
    "region" : "xxx",
    "id" : "a1645603-9814-44f9-ba19-1c565af9eb81",
    "address" : "215.255.1.80"
  },
  "ptrdnames" : [ "www.example.com.", "mail.example.com." ],
  "id" : "9a175b97889f2f3501889fa3a8a66ed0",
  "description" : "Description for this PTR records",
  "ttl" : 300,
  "status" : "ACTIVE",
  "links" : {
    "self" : "https://Endpoint/v2.1/ptrs/9a175b97889f2f3501889fa3a8a66ed0"
  },
  "enterprise_project_id" : 0
}

Status Codes

Status Code

Description

200

Successful request

Error Codes

See Error Codes.