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

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.1/ptrs

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

marker

No

String

Start resource ID at the beginning for paginagtion query. If the parameter is left blank, only resources on the first page are queried.

It 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. 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.

Range: 0 to 2147483647

Default value: 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 can contain 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

resource_type

No

String

EIP type.

Value options:

publicip: EIP

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

floatingips

Array of FloatingIpsPtr objects

PTR record list

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.

Table 4 FloatingIpsPtr

Parameter

Type

Description

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

publicip

PublicIpRes object

EIP

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.

tags

Array of tag objects

Resource tag

Table 5 PublicIpRes

Parameter

Type

Description

region

String

Region to which the EIP belongs

id

String

EIP ID

address

String

EIP

Table 6 tag

Parameter

Type

Description

key

String

Definition

The tag key.

Range

  • Cannot be left blank.

  • Must be unique for each resource.

  • Contains up to 128 characters.

  • Cannot start or end with a space, or start with sys. Only letters, digits, spaces, and the following special characters are allowed: _.:=+-@

value

String

Definition

The tag value.

Range

  • Can be left blank.

  • Can contain a maximum of 255 characters.

  • Only letters, digits, spaces, and the following special characters are allowed: _.:/=+-@

Table 8 metadata

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

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

Querying PTR records of an EIP

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

Example Responses

Status code: 200

Successful request

{
  "floatingips" : [ {
    "ptrdnames" : [ "www.example.com.", "mail.example.com." ],
    "id" : "9a175b97889f2f3501889fa3a8a66ed0",
    "publicip" : {
      "region" : "xxx",
      "id" : "a1645603-9814-44f9-ba19-1c565af9eb81",
      "address" : "215.255.1.80"
    },
    "ttl" : 300,
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2.1/ptrs/9a175b97889f2f3501889fa3a8a66ed0"
    },
    "enterprise_project_id" : 0,
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  } ],
  "links" : {
    "self" : "https://Endpoint/v2.1/ptrs"
  },
  "metadata" : {
    "total_count" : 1
  }
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dns.v2.region.DnsRegion;
import com.huaweicloud.sdk.dns.v2.*;
import com.huaweicloud.sdk.dns.v2.model.*;


public class ListPtrsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListPtrsRequest request = new ListPtrsRequest();
        try {
            ListPtrsResponse response = client.listPtrs(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListPtrsRequest()
        response = client.list_ptrs(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dns.NewDnsClient(
        dns.DnsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListPtrsRequest{}
	response, err := client.ListPtrs(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Successful request

400

Request error

500

Request error

Error Codes

See Error Codes.