Querying a Recycling Policy
Function
This API is used to query a recycling policy. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
GET /v3/{project_id}/instances/recycle-policy
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. |
|
Content-Type |
Yes |
String |
Content type. Value: application/json |
|
X-Language |
No |
String |
Language. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
recycle_policy |
RecyclePolicy object |
Recycling policy. |
|
Parameter |
Type |
Description |
|---|---|---|
|
retention_period_in_days |
String |
Retention period, in days. Value range: 1–7. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Request
Querying a recycling policy
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/recycle-policy
Example Response
Status code: 200
Success.
{
"recycle_policy" : {
"retention_period_in_days" : 5
}
}
Status Code
|
Status Code |
Description |
|---|---|
|
200 |
Success. |
|
400 |
Client error. |
|
500 |
Server error. |
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
