Updated on 2026-09-28 GMT+08:00

Creating a PTR Record for an EIP

Function

This API is used to create 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:create

    Write

    ptr *

    -

    dns:ptr:set

    • dns:tag:set
    • eip:publicIps:get
    • dns:quota:list

    -

    • g:RequestTag/<tag-key>

    • g:TagKeys

    • g:EnterpriseProjectId

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

region

Yes

String

Definition

Region of the tenant. To obtain the region ID, you can call the API for querying regions or see Regions and Endpoints.

Constraints

N/A

Range

N/A

Default Value

N/A

floatingip_id

Yes

String

Definition

EIP ID. To obtain the value, call the API for querying the EIP list.

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

ptrdname

Yes

String

Definition

The domain name of the PTR record.

Constraints

N/A

Range

N/A

Default Value

N/A

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

enterprise_project_id

No

String

Definition

ID of the enterprise project associated with the PTR record. You can obtain the value by calling the API for querying enterprise projects.

Constraints

N/A

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.

Default Value

0

tags

No

Array of tagReq objects

Definition

Resource tags. The value is an array. Each element contains a tag key and tag value, which are used to manage and filter resource tags.

Constraints

N/A

Table 4 tagReq

Parameter

Mandatory

Type

Description

key

Yes

String

Definition

Tag key.

Constraints

  • It cannot be left blank.

  • It must be unique for each resource.

  • It cannot start with _sys_ or a space or end with a space.

Range

  • The key can contain a maximum of 128 characters.

  • The key can contain letters, digits, spaces, and the following special characters: _.:=+-@

Default Value

N/A

value

No

String

Definition

Tag value.

Constraints

  • It can be left blank.

Range

  • The value can contain a maximum of 255 characters.

  • The value can contain letters, digits, spaces, and the following special characters: _.:/=+-@

Default Value

N/A

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

id

String

Definition

PTR record ID.

Range

The format is {region}:{floatingip_id}.

ptrdname

String

Definition

The domain name of the PTR record.

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

address

String

Definition

EIP.

Range

N/A

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

action

String

Definition

Requested operation on the resource.

Range

  • CREATE: Create

  • UPDATE: Update

  • DELETE: Delete

  • NONE: No operation

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.

Example Requests

Creating a PTR record for an EIP and setting its TTL to 300s

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

{
  "ptrdname" : "www.example.com",
  "description" : "Description for this PTR record",
  "ttl" : 300,
  "tags" : [ {
    "key" : "key1",
    "value" : "value1"
  } ]
}

Example Responses

Status code: 202

{
  "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"
  },
  "enterprise_project_id" : "0"
}

SDK Sample Code

The SDK sample code is as follows.

Creating a PTR record for an EIP and setting its 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
59
60
61
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 CreateEipRecordSetSolution {

    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();
        CreateEipRecordSetRequest request = new CreateEipRecordSetRequest();
        request.withRegion("{region}");
        request.withFloatingipId("{floatingip_id}");
        CreatePtrReq body = new CreatePtrReq();
        List<Tag> listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new Tag()
                .withKey("key1")
                .withValue("value1")
        );
        body.withTags(listbodyTags);
        body.withTtl(300);
        body.withDescription("Description for this PTR record");
        body.withPtrdname("www.example.com");
        request.withBody(body);
        try {
            CreateEipRecordSetResponse response = client.createEipRecordSet(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());
        }
    }
}

Creating a PTR record for an EIP and setting its 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
# 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 = CreateEipRecordSetRequest()
        request.region = "{region}"
        request.floatingip_id = "{floatingip_id}"
        listTagsbody = [
            Tag(
                key="key1",
                value="value1"
            )
        ]
        request.body = CreatePtrReq(
            tags=listTagsbody,
            ttl=300,
            description="Description for this PTR record",
            ptrdname="www.example.com"
        )
        response = client.create_eip_record_set(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Creating a PTR record for an EIP and setting its 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
59
60
61
62
63
64
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.CreateEipRecordSetRequest{}
	request.Region = "{region}"
	request.FloatingipId = "{floatingip_id}"
	valueTags:= "value1"
	var listTagsbody = []model.Tag{
        {
            Key: "key1",
            Value: &valueTags,
        },
    }
	ttlCreatePtrReq:= int32(300)
	descriptionCreatePtrReq:= "Description for this PTR record"
	request.Body = &model.CreatePtrReq{
		Tags: &listTagsbody,
		Ttl: &ttlCreatePtrReq,
		Description: &descriptionCreatePtrReq,
		Ptrdname: "www.example.com",
	}
	response, err := client.CreateEipRecordSet(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.