Updated on 2026-09-28 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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dns:ptr:update

    Write

    ptr *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    dns:ptr:set

    -

URI

PUT /v2.1/ptrs/{ptr_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

ptr_id

Yes

String

Definition

PTR record ID. You can call the API (ListPtrRecords) for querying PTR records to obtain the IDs.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which is used for identity authentication. It must be carried in the request header to verify the user identity during API calls.

You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, see Obtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ptrdnames

Yes

Array of strings

Definition

Domain names associated with the PTR record. This field is a string array. Each element is the domain name of a PTR record.

Constraints

A maximum of 10 domain names is allowed.

description

No

String

Definition

Description about the PTR record.

Constraints

N/A

Range

N/A

Default Value

N/A

ttl

No

Integer

Definition

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

Constraints

N/A

Range

1 to 2147483647

Default Value

N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

publicip

PublicIpRes object

Definition

EIP object, which specifies the EIP associated with the PTR record, including the region and EIP ID.

ptrdnames

Array of strings

Definition

List of domain names of the PTR record. A maximum of 10 domain names is allowed. This field is a string array. Each element is the domain name of a PTR record.

id

String

Definition

PTR record ID.

Range

N/A

description

String

Definition

Description about the PTR record.

Range

N/A

ttl

Integer

Definition

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

Range

1 to 2147483647

status

String

Definition

Resource status.

Range

  • ACTIVE: Normal

  • PENDING_CREATE: Creating

  • PENDING_UPDATE: Updating

  • PENDING_DELETE: Deleting

  • PENDING_FREEZE: Freezing

  • FREEZE: Frozen

  • ILLEGAL: Frozen due to violations

  • POLICE: Frozen due to security reasons

  • ERROR: Failed

links

pageLink object

Definition

Links to the current page and the next page. If pagination is required for querying resources, a next field is required to point to the next page.

enterprise_project_id

String

Definition

ID of the enterprise project associated with the PTR record.

Range

The value is 0 or a string that contains a maximum of 36 bytes in the UUID format with hyphens (-). 0 indicates the default enterprise project.

Table 5 PublicIpRes

Parameter

Type

Description

region

String

Definition

Region to which the EIP belongs.

Range

N/A

id

String

Definition

EIP ID.

Range

N/A

address

String

Definition

EIP.

Range

N/A

Example Requests

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

PUT https://{Endpoint}/v2.1/ptrs/9a175b97889f2f3501889fa3a8a66ed0

{
  "ptrdnames" : [ "www.example.com" ],
  "description" : "Description for this PTR records",
  "ttl" : 300
}

Example Responses

Status code: 202

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

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
53
54
55
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.*;

import java.util.List;
import java.util.ArrayList;

public class UpdatePtrSolution {

    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();
        UpdatePtrRequest request = new UpdatePtrRequest();
        request.withPtrId("{ptr_id}");
        UpdatePtrRequestBody body = new UpdatePtrRequestBody();
        List<String> listbodyPtrdnames = new ArrayList<>();
        listbodyPtrdnames.add("www.example.com");
        body.withTtl(300);
        body.withDescription("Description for this PTR records");
        body.withPtrdnames(listbodyPtrdnames);
        request.withBody(body);
        try {
            UpdatePtrResponse response = client.updatePtr(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
38
39
# 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 = UpdatePtrRequest()
        request.ptr_id = "{ptr_id}"
        listPtrdnamesbody = [
            "www.example.com"
        ]
        request.body = UpdatePtrRequestBody(
            ttl=300,
            description="Description for this PTR records",
            ptrdnames=listPtrdnamesbody
        )
        response = client.update_ptr(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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dns.DnsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dns.NewDnsClient(hcClient)

    request := &model.UpdatePtrRequest{}
	request.PtrId = "{ptr_id}"
	var listPtrdnamesbody = []string{
        "www.example.com",
    }
	ttlUpdatePtrRequestBody:= int32(300)
	descriptionUpdatePtrRequestBody:= "Description for this PTR records"
	request.Body = &model.UpdatePtrRequestBody{
		Ttl: &ttlUpdatePtrRequestBody,
		Description: &descriptionUpdatePtrRequestBody,
		Ptrdnames: listPtrdnamesbody,
	}
	response, err := client.UpdatePtr(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.