Modifying the PTR Record of an EIP
Function
This API is used to modify the PTR record of an EIP.
Calling Method
For details, see Calling APIs.
URI
PATCH /v2/reverse/floatingips/{region}:{floatingip_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
region |
Yes |
String |
Region of the zone |
floatingip_id |
Yes |
String |
ID of the PTR record to be modified |
Request 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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ptrdname |
Yes |
String |
Domain name of the PTR record |
description |
No |
String |
PTR record description |
ttl |
No |
Integer |
Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect. |
tags |
No |
Array of tag objects |
Resource 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
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 |
Record set 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. Value options: CREATE, UPDATE, DELETE, NONE, CREATE, UPDATE, and DELETE NONE: 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. |
Example Requests
Modifying the domain name and description of the PTR record and set the TTL to 300s
PATCH https://{endpoint}/v2/reverse/floatingips/{region}:{floatingip_id} { "ptrdname" : "www.example.com", "description" : "Description for this PTR record", "ttl" : 300 }
Example Responses
Status code: 202
Response to the request for modifying the PTR record of an EIP
{ "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" } }
SDK Sample Code
The SDK sample code is as follows.
Modifying the domain name and description of the PTR record and set 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 |
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.*; public class UpdatePtrRecordSolution { 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(); UpdatePtrRecordRequest request = new UpdatePtrRecordRequest(); UpdatePtrReq body = new UpdatePtrReq(); body.withTtl(300); body.withDescription("Description for this PTR record"); body.withPtrdname("www.example.com"); request.withBody(body); try { UpdatePtrRecordResponse response = client.updatePtrRecord(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 the PTR record and set 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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DnsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DnsRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdatePtrRecordRequest() request.body = UpdatePtrReq( ttl=300, description="Description for this PTR record", ptrdname="www.example.com" ) response = client.update_ptr_record(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 the PTR record and set 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 |
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.UpdatePtrRecordRequest{} ttlUpdatePtrReq:= int32(300) descriptionUpdatePtrReq:= "Description for this PTR record" request.Body = &model.UpdatePtrReq{ Ttl: &ttlUpdatePtrReq, Description: &descriptionUpdatePtrReq, Ptrdname: "www.example.com", } response, err := client.UpdatePtrRecord(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 |
---|---|
200 |
Response to the request for modifying the PTR record of an EIP |
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