Updated on 2026-08-19 GMT+08:00

Updating the Recycle Bin Policy

Function

This API is used to update the recycle bin policy.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/recycle

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

retention_days

No

Integer

Definition

Retention period (in days).

Constraints

N/A

Range

1–7

Default Value

N/A

default_use_recycle

No

Boolean

Definition

Whether to use a recycle bin.

Constraints

N/A

Range

  • true: Use a recycle bin.

  • false: Do not use a recycle bin.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

retention_days

Integer

Definition

Retention days.

Range

1–7

default_use_recycle

Boolean

Definition

Whether to use the recycle bin.

Range

  • true: Yes

  • false: No

recycle_instances

Array of InstanceRecycleInfo objects

Definition

Recycled instance list.

Range

N/A

Table 4 InstanceRecycleInfo

Parameter

Type

Description

instance_id

String

Definition

Instance ID.

Range

N/A

status

String

Definition

Instance status.

Range

For details, see Instance Status.

name

String

Definition

Instance name.

Range

N/A

engine

String

Definition

Message engine type.

Range

  • rocketmq: RocketMQ message engine.

  • reliability: RocketMQ message engine alias.

in_recycle_time

Long

Definition

Recycle time.

Range

N/A

save_time

Integer

Definition

Retention period.

Range

1–7

auto_delete_time

Long

Definition

Automatic deletion time.

Range

N/A

cost_per_hour

Double

Definition

Hourly fee.

Range

N/A

error_message

String

Definition

Error message.

Range

N/A

product_id

String

Definition

Product ID.

Range

N/A

Example Requests

Updating the recycle bin policy

PUT https://{endpoint}/v2/{project_id}/recycle

{
  "retention_days" : 2,
  "default_use_recycle" : true
}

Example Responses

Status code: 200

Recycle bin policy updated.

{
  "retention_days" : 2,
  "default_use_recycle" : true,
  "recycle_instances" : [ ]
}

SDK Sample Code

The SDK sample code is as follows.

Updating the recycle bin policy

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion;
import com.huaweicloud.sdk.rocketmq.v2.*;
import com.huaweicloud.sdk.rocketmq.v2.model.*;


public class ModifyRecyclePolicySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        RocketMQClient client = RocketMQClient.newBuilder()
                .withCredential(auth)
                .withRegion(RocketMQRegion.valueOf("<YOUR REGION>"))
                .build();
        ModifyRecyclePolicyRequest request = new ModifyRecyclePolicyRequest();
        ModifyRecyclePolicyReq body = new ModifyRecyclePolicyReq();
        body.withDefaultUseRecycle(true);
        body.withRetentionDays(2);
        request.withBody(body);
        try {
            ModifyRecyclePolicyResponse response = client.modifyRecyclePolicy(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Updating the recycle bin policy

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkrocketmq.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = RocketMQClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ModifyRecyclePolicyRequest()
        request.body = ModifyRecyclePolicyReq(
            default_use_recycle=True,
            retention_days=2
        )
        response = client.modify_recycle_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Updating the recycle bin policy

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := rocketmq.RocketMQClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := rocketmq.NewRocketMQClient(hcClient)

    request := &model.ModifyRecyclePolicyRequest{}
	defaultUseRecycleModifyRecyclePolicyReq:= true
	retentionDaysModifyRecyclePolicyReq:= int32(2)
	request.Body = &model.ModifyRecyclePolicyReq{
		DefaultUseRecycle: &defaultUseRecycleModifyRecyclePolicyReq,
		RetentionDays: &retentionDaysModifyRecyclePolicyReq,
	}
	response, err := client.ModifyRecyclePolicy(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Recycle bin policy updated.

Error Codes

See Error Codes.