Updated on 2024-09-11 GMT+08:00

Modifying a Recycling Policy

Function

This API is used to modify a recycling policy. Before calling this API:

URI

PUT /v3/{project_id}/instances/recycle-policy

Table 1 URI parameter

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

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

To obtain the value, call the 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.

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

recycle_policy

No

Table 4 object

Recycling policy.

Table 4 RecyclePolicy

Parameter

Mandatory

Type

Description

retention_period_in_days

Yes

String

Retention period, in days. Value range: 1 to 7

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Setting the retention period to 5 days during the recycling policy modification

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/recycle-policy

{
  "recycle_policy" : {
    "retention_period_in_days" : 5
  }
}

Example Response

None

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.