Enabling or Disabling Recycle Bin
Function
This API is used to enable or disable recycle bin. Once this option is enabled, deleted load balancers will be kept in the recycle bin. If this option is not enabled, deleted load balancers will be permanently deleted and cannot be restored. Before disabling recycle bin, restore or permanently delete load balancers from the recycle bin.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/elb/recycle-bin
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
recycle_bin |
No |
RecycleBinRequestBody object |
Definition: Request body for updating the value of enable for the recycle bin. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
recycle_bin |
RecycleBinResponseBody object |
Definition: Specifies the response body for the recycle bin. |
Parameter |
Type |
Description |
---|---|---|
project_id |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. |
policy |
RecycleBinPolicy object |
Definition: Specifies the recycle bin policy. |
enable |
Boolean |
Definition: Specifies whether to enable recycle bin. Range:
|
Parameter |
Type |
Description |
---|---|---|
recycle_threshold_hour |
Integer |
Definition: Specifies how old a deleted or unsubscribed load balancer has to be for it to be moved to the recycle bin. A load balancer can only be moved to the recycle bin if it has been there longer than the specified number of days in the policy. Range: N/A |
retention_hour |
Integer |
Definition: Specifies how long you want your load balancers to be kept in the recycle bin. Range: N/A |
Example Requests
https://{ELB_Endpoint}/v3/7b7705dce1e847b08b3b16dda67fec24/elb/recycle-bin { "recycle_bin" : { "enable" : false } }
Example Responses
Status code: 200
Query succeeded.
{ "recycle_bin" : { "enable" : true, "policy" : { "recycle_threshold_hour" : 20, "retention_hour" : 20 }, "project_id" : "7b7705dce1e847b08b3b16dda67fec24" } }
SDK Sample Code
The SDK sample code is as follows.
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 |
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.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class UpdateRecycleBinEnableSolution { 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); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("<YOUR REGION>")) .build(); UpdateRecycleBinEnableRequest request = new UpdateRecycleBinEnableRequest(); UpdateRecycleBinEnableRequestBody body = new UpdateRecycleBinEnableRequestBody(); RecycleBinRequestBody recycleBinbody = new RecycleBinRequestBody(); recycleBinbody.withEnable(false); body.withRecycleBin(recycleBinbody); request.withBody(body); try { UpdateRecycleBinEnableResponse response = client.updateRecycleBinEnable(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 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 = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateRecycleBinEnableRequest() recycleBinbody = RecycleBinRequestBody( enable=False ) request.body = UpdateRecycleBinEnableRequestBody( recycle_bin=recycleBinbody ) response = client.update_recycle_bin_enable(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateRecycleBinEnableRequest{} enableRecycleBin:= false recycleBinbody := &model.RecycleBinRequestBody{ Enable: &enableRecycleBin, } request.Body = &model.UpdateRecycleBinEnableRequestBody{ RecycleBin: recycleBinbody, } response, err := client.UpdateRecycleBinEnable(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 |
Query succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot