Updated on 2025-11-13 GMT+08:00

Querying the Recycle Bin Policy

Function

This API is used to query the recycle bin policy.

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/recycle-bin-volumes/policy

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token.

You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

switch

Boolean

Definition

The recycle bin switch.

Range

  • true: The recycle bin is enabled.

  • false: The recycle bin is disabled.

threshold_time

Integer

Definition

The minimum number of days that must pass after a disk was created before it can be moved to the recycle bin upon deletion.

Range

1–1000

keep_time

Integer

Definition

The retention period (days) of disks in the recycle bin before they are permanently deleted.

Range

1–365

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error code returned if an error occurs. For details about the error code, see Error Codes.

Range

N/A

Table 5 Error

Parameter

Type

Description

code

String

Definition

The error code returned if an error occurs.

Range

For details about the error code, see Error Codes.

message

String

Definition

The error message returned if an error occurs.

Range

N/A

Example Requests

GET https://evs.cn-north-1.myhuaweicloud.com/v3/490e121341fc481d95f946ef844cb06a/recycle-bin-volumes/policy

Example Responses

Status code: 200

OK

{
  "switch" : true,
  "threshold_time" : 7,
  "keep_time" : 7
}

Status code: 400

Bad Request

{
  "error" : {
    "message" : "XXXX",
    "code" : "XXX"
  }
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.