Updated on 2025-09-04 GMT+08:00

Querying a Recycling Policy

Function

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

URI

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

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

recycle_policy

RecyclePolicy object

Definition

Recycling policy.

Constraints

N/A

Table 4 RecyclePolicy

Parameter

Type

Description

retention_period_in_days

String

Definition

Retention days.

Constraints

N/A

Range

1–7

Default Value

N/A

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

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

For details, see Status Codes.

Error Code

For details, see Error Codes.