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

Querying All PTR Records

Function

Query PTR records of EIPs.

URI

GET /v2/reverse/floatingips

For details, see Table 1.
Table 1 Parameters in the URI

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.

The value 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.

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 (,).

The tags are in AND relationship.

Exact matching will work. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk.

The value is left blank by default.

status

No

String

Resource status

For details, see Resource Status.

Request

  • Request parameters

    None

  • Example request

    List required PTR records.

    GET https://{DNS_Endpoint}/v2/reverse/floatingips

Response

  • Parameter description
    Table 2 Parameters in the response

    Parameter

    Type

    Description

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

    metadata

    Object

    Number of resources that meet the filter condition. For details, see Table 4.

    floatingips

    Array of object

    PTR record object list. For details, see Table 3.

    Table 3 Description of the floatingips field

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

    The value ranges from 1 to 2147483647.

    The default value is 300.

    address

    String

    EIP

    status

    String

    Resource status

    For details, see 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

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

    tags

    Array of tag objects

    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 (,).

    The tags are in AND relationship.

    For details, see Table 6.

    Exact matching will work. If the value starts with an asterisk (*), fuzzy matching will work for the string following the asterisk.

    The value is left blank by default.

    Table 4 Description of the metadata field

    Parameter

    Type

    Description

    total_count

    Integer

    Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

    Table 5 Parameters in the links field

    Parameter

    Type

    Description

    self

    String

    Link to the current resource

    next

    String

    Link to the next page

    Table 6 Description of the tag field

    Parameter

    Type

    Description

    key

    String

    Tag key

    A key can contain up to 36 Unicode characters. key must be specified. Equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), commas (,), vertical bars (|), and slashes (/) are not allowed. The first and last characters cannot be spaces.

    value

    String

    Tag value

    Each value can contain a maximum of 43 Unicode characters and can be an empty string. Equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), commas (,), vertical bars (|), and slashes (/) are not allowed. The first and last characters cannot be spaces.

  • Example response
    {
        "links": {
            "self": "https://Endpoint/v2/reverse/floatingips",
            "next": "https://Endpoint/v2/zones?id=&limit=1&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"
                }
            }
        ]
    }

Returned Value

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

For details, see Status Code.