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

Modifying a PTR Record for an EIP

Function

This API is used to modify a PTR record for an EIP.

Calling Method

For details, see Calling APIs.

URI

PATCH /v2/reverse/floatingips/{region}:{floatingip_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

region

Yes

String

Region of the zone.

floatingip_id

Yes

String

EIP 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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ptrdname

Yes

String

The zone of the PTR record

description

No

String

Descriptions about the PTR record

ttl

No

Integer

PTR record caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect.

tags

No

Array of tag objects

Resource tag.

Table 4 tag

Parameter

Mandatory

Type

Description

key

Yes

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

No

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: _.:/=+-@

Response Parameters

Status code: 202

Table 5 Response body parameters

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

Example Requests

Modifying the domain name and description of a PTR record and setting the TTL to 300s

PATCH https://{endpoint}/v2/reverse/floatingips/{region}:{floatingip_id}

{
  "ptrdname" : "www.example.com",
  "description" : "Description for this PTR record",
  "ttl" : 300
}

Example Responses

Status code: 202

Request accepted

{
  "id" : "region_id:c5504932-bf23-4171-b655-b87a6bc59334",
  "ptrdname" : "www.example.com.",
  "description" : "Description for this PTR record",
  "address" : "10.154.52.138",
  "action" : "CREATE",
  "ttl" : 300,
  "status" : "PENDING_CREATE",
  "links" : {
    "self" : "https://Endpoint/v2/reverse/floatingips/region_id:c5504932-bf23-4171-b655-b87a6bc59334"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Modifying the domain name and description of a PTR record and setting the TTL to 300s

 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
46
47
48
49
50
51
52
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 UpdatePtrRecordSolution {

    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();
        UpdatePtrRecordRequest request = new UpdatePtrRecordRequest();
        request.withRegion("{region}");
        request.withFloatingipId("{floatingip_id}");
        UpdatePtrReq body = new UpdatePtrReq();
        body.withTtl(300);
        body.withDescription("Description for this PTR record");
        body.withPtrdname("www.example.com");
        request.withBody(body);
        try {
            UpdatePtrRecordResponse response = client.updatePtrRecord(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());
        }
    }
}

Modifying the domain name and description of a PTR record and setting the TTL to 300s

 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
# 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 = UpdatePtrRecordRequest()
        request.region = "{region}"
        request.floatingip_id = "{floatingip_id}"
        request.body = UpdatePtrReq(
            ttl=300,
            description="Description for this PTR record",
            ptrdname="www.example.com"
        )
        response = client.update_ptr_record(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Modifying the domain name and description of a PTR record and setting the TTL to 300s

 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
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.UpdatePtrRecordRequest{}
	request.Region = "{region}"
	request.FloatingipId = "{floatingip_id}"
	ttlUpdatePtrReq:= int32(300)
	descriptionUpdatePtrReq:= "Description for this PTR record"
	request.Body = &model.UpdatePtrReq{
		Ttl: &ttlUpdatePtrReq,
		Description: &descriptionUpdatePtrReq,
		Ptrdname: "www.example.com",
	}
	response, err := client.UpdatePtrRecord(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

202

Request accepted

Error Codes

See Error Codes.