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.
URI
POST /v2.1/ptrs
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 |
|---|---|---|---|
|
publicip |
No |
PublicIpReq object |
EIP |
|
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. |
|
tags |
No |
Array of tag objects |
Resource tag |
|
enterprise_project_id |
No |
String |
ID of the enterprise project associated with the PTR record. The value can contain a maximum of 36 characters. The default value is 0. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
region |
No |
String |
Region to which the EIP belongs |
|
id |
No |
String |
EIP ID |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
key |
Yes |
String |
Definition The tag key. Range
|
|
value |
No |
String |
Definition The tag value. Range
|
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
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
Request accepted
{
"publicip" : {
"region" : "xxx",
"id" : "a1645603-9814-44f9-ba19-1c565af9eb81",
"address" : "215.255.1.80"
},
"ptrdnames" : [ "www.example.com.", "mail.example.com." ],
"id" : "9a175b97889f2f3501889fa3a8a66ed0",
"ttl" : 300,
"status" : "PENDING_CREATE",
"links" : {
"self" : "https://Endpoint/v2.1/ptrs/9a175b97889f2f3501889fa3a8a66ed0"
},
"enterprise_project_id" : 0
}
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.