Updated on 2024-12-20 GMT+08:00

Creating a PTR Record for an EIP

Function

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

floatingip_id

Yes

String

EIP ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ptrdname

Yes

String

Domain name of the PTR record

description

No

String

PTR record description

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. The value ranges from 1 to 2147483647.

enterprise_project_id

No

String

ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters.

tags

No

Array of tag objects

Resource tag

Table 4 tag

Parameter

Mandatory

Type

Description

key

Yes

String

Tag key. A key can contain up to 36 Unicode characters. It cannot be left blank. A tag value cannot contain special characters (=*<>,|/) or start or end with spaces.

value

No

String

Tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. A tag value cannot contain special characters (=*<>,|/) or start or end with spaces.

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

Domain name of the PTR record

description

String

PTR record description

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

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

Link of the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results.

enterprise_project_id

String

ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters.

Example Requests

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

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 300 seconds

 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 300 seconds

 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 300 seconds

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

Response to the request for configuring the PTR record of an EIP

Error Codes

See Error Codes.