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.
URI
POST /v2.1/ptrs
Request 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| publicip | No | PublicIpReq object | Definition EIP object, which specifies the EIP associated with the PTR record, including the region and EIP ID. Constraints N/A |
| 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 |
| 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 |
| 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| region | No | String | Definition Region to which the EIP belongs. 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 |
| id | No | 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 |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| key | Yes | String | Definition Tag key. Constraints Range Default Value N/A |
| value | No | String | Definition Tag value. Constraints Range Default Value N/A |
Response Parameters
Status code: 202
| 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 |
| 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
POST https://{Endpoint}/v2.1/ptrs
{
"publicip" : {
"region" : "xxx",
"id" : "a1645603-9814-44f9-ba19-1c565af9eb81"
},
"ptrdnames" : [ "www.example.com", "mail.example.com" ],
"description" : "Description for this PTR records",
"ttl" : 300,
"tags" : [ {
"key" : "key1",
"value" : "value1"
} ],
"enterprise_project_id" : "0"
} Example Responses
Status code: 202
{
"publicip" : {
"region" : "xxx",
"id" : "a1645603-9814-44f9-ba19-1c565af9eb81",
"address" : "215.255.1.80"
},
"ptrdnames" : [ "www.example.com.", "mail.example.com." ],
"id" : "9a175b97889f2f3501889fa3a8a66ed0",
"description" : "Description for this PTR records",
"ttl" : 300,
"status" : "PENDING_CREATE",
"links" : {
"self" : "https://{Endpoint}/v2.1/ptrs/9a175b97889f2f3501889fa3a8a66ed0"
},
"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 62 63 64 65 66 67 | 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 CreatePtrSolution { 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(); CreatePtrRequest request = new CreatePtrRequest(); CreatePtrRequestBody body = new CreatePtrRequestBody(); List<Tag> listbodyTags = new ArrayList<>(); listbodyTags.add( new Tag() .withKey("key1") .withValue("value1") ); List<String> listbodyPtrdnames = new ArrayList<>(); listbodyPtrdnames.add("www.example.com"); listbodyPtrdnames.add("mail.example.com"); PublicIpReq publicipbody = new PublicIpReq(); publicipbody.withRegion("xxx") .withId("a1645603-9814-44f9-ba19-1c565af9eb81"); body.withEnterpriseProjectId("0"); body.withTags(listbodyTags); body.withTtl(300); body.withDescription("Description for this PTR records"); body.withPtrdnames(listbodyPtrdnames); body.withPublicip(publicipbody); request.withBody(body); try { CreatePtrResponse response = client.createPtr(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 45 46 47 48 49 50 51 52 | # 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 = CreatePtrRequest() listTagsbody = [ Tag( key="key1", value="value1" ) ] listPtrdnamesbody = [ "www.example.com", "mail.example.com" ] publicipbody = PublicIpReq( region="xxx", id="a1645603-9814-44f9-ba19-1c565af9eb81" ) request.body = CreatePtrRequestBody( enterprise_project_id="0", tags=listTagsbody, ttl=300, description="Description for this PTR records", ptrdnames=listPtrdnamesbody, publicip=publicipbody ) response = client.create_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) |
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 65 66 67 68 69 70 71 72 73 74 75 | 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.CreatePtrRequest{} valueTags:= "value1" var listTagsbody = []model.Tag{ { Key: "key1", Value: &valueTags, }, } var listPtrdnamesbody = []string{ "www.example.com", "mail.example.com", } regionPublicip:= "xxx" idPublicip:= "a1645603-9814-44f9-ba19-1c565af9eb81" publicipbody := &model.PublicIpReq{ Region: ®ionPublicip, Id: &idPublicip, } enterpriseProjectIdCreatePtrRequestBody:= "0" ttlCreatePtrRequestBody:= int32(300) descriptionCreatePtrRequestBody:= "Description for this PTR records" request.Body = &model.CreatePtrRequestBody{ EnterpriseProjectId: &enterpriseProjectIdCreatePtrRequestBody, Tags: &listTagsbody, Ttl: &ttlCreatePtrRequestBody, Description: &descriptionCreatePtrRequestBody, Ptrdnames: listPtrdnamesbody, Publicip: publicipbody, } response, err := client.CreatePtr(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.
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot