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
PUT /v2.1/ptrs/{ptr_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ptr_id |
Yes |
String |
PTR record ID |
Request 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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ptrdnames |
Yes |
Array of strings |
List of domain names of the PTR record. A maximum of 10 domain names are allowed. |
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. The value ranges from 1 to 2147483647. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
publicip |
PublicIpRes object |
EIP |
ptrdnames |
Array of strings |
List of domain names of the PTR record. A maximum of 10 domain names are allowed. |
id |
String |
PTR record ID |
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. |
status |
String |
Resource status |
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 |
enterprise_project_id |
String |
ID of the enterprise project associated with the PTR record. The value can contain a maximum of 36 characters. |
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
Request accepted
{ "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" } }
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 |
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.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.
Feedback
Was this page helpful?
Provide feedbackThank 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