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.
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:update
Write
ptr *
-
g:ResourceTag/<tag-key>
-
g:EnterpriseProjectId
- dns:ptr:set
-
-
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"
}
}
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.