Querying Instances in the Recycle Bin
Function
This API is used to query instances in the recycle bin. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependency
gaussdbformysql:instance:list
List
-
-
gaussdb:instance:list
-
URI
GET /v3/{project_id}/instances/recycle-info
|
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 |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
No |
Integer |
Definition Number of records to be queried. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 100 |
|
offset |
No |
Integer |
Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be an integer and cannot be a negative number. Range ≥ 0 Default Value 0 |
Request 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 Default Value en-us |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
total_count |
Integer |
Definition Total number of records. Range N/A |
|
instances |
Array of RecycleInstanceV3 objects |
Definition Instances in the recycle bin. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Definition Instance ID. Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed. |
|
name |
String |
Definition Instance name. Range The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed. |
|
ha_mode |
String |
Definition Instance type. Range N/A |
|
engine_name |
String |
Definition Engine name. Range N/A |
|
engine_version |
String |
Definition Engine version. Range N/A |
|
pay_model |
String |
Definition Billing mode. Range N/A |
|
create_at |
Integer |
Definition Creation time. Range N/A |
|
deleted_at |
Integer |
Definition Deletion time. Range N/A |
|
volume_type |
String |
Definition Storage type. Range |
|
volume_size |
String |
Definition Storage size. Range N/A |
|
data_vip |
String |
Definition Virtual IP address of the data plane. Range N/A |
|
data_vip_ipv6 |
String |
Definition IPv6 address of the data plane. Range N/A |
|
enterprise_project_id |
String |
Definition Enterprise project ID. Range N/A |
|
enterprise_project_name |
String |
Definition Enterprise project name. Range N/A |
|
backup_level |
String |
Definition Level of the most recent backup for an instance in the recycle bin. Range |
|
recycle_backup_id |
String |
Definition ID of the most recent backup for an instance in the recycle bin. Range N/A |
|
recycle_status |
String |
Definition Recycling status of the most recent backup for an instance in the recycle bin. Range |
|
recycle_backups |
Array of RecycleBackupV3 objects |
Definition List of all backups for an instance in the recycle bin. |
|
Parameter |
Type |
Description |
|---|---|---|
|
backup_level |
String |
Definition Backup level. Range |
|
backup_id |
String |
Definition Backup ID. Range N/A |
|
backup_name |
String |
Definition Backup name. Range N/A |
|
size |
Integer |
Definition Backup size, in bytes. Range N/A |
|
status |
String |
Definition Recycling status. Range |
|
begin_time |
String |
Definition Backup start time. Range N/A |
|
end_time |
String |
Definition Backup end time. Range N/A |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Request
Querying instances in the recycle bin
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/recycle-info
Example Response
Status code: 200
Success.
{
"total_count" : 2,
"instances" : [ {
"id" : "090e539b45e047ee9cc17750b321ef7ein07",
"name" : "gauss-dd-single",
"ha_mode" : "StandSingle",
"engine_name" : "taurus",
"engine_version" : "2.0.51.240300",
"pay_model" : "0",
"create_at" : 1712656933705,
"deleted_at" : 1712659228276,
"volume_type" : "",
"volume_size" : "0",
"data_vip" : "172.16.1.234",
"data_vip_ipv6" : null,
"enterprise_project_id" : "0",
"enterprise_project_name" : "default",
"backup_level" : "2",
"recycle_backup_id" : "c62e218ccd6c49098baa925453c65e29br07",
"recycle_status" : "Active",
"recycle_backups" : [ {
"backup_level" : 2,
"backup_id" : "c62e218ccd6c49098baa925453c65e29br07",
"backup_name" : "taurus-090e539b45e047ee9cc17750b321ef7ein07-2024112609134619",
"size" : 74678272,
"status" : "Active",
"begin_time" : 1764148420050,
"end_time" : 1764148668780
}, {
"backup_level" : 2,
"backup_id" : "97ae2184446c49098baa925453c65e29br07",
"backup_name" : "taurus-090e539b45e047ee9cc17750b321ef7ein07-2025112609134619",
"size" : 75678272,
"status" : "Active",
"begin_time" : 1764148426056,
"end_time" : 1764148668780
} ]
}, {
"id" : "632423cc56c348bd967b3a03e7abdab9in07",
"name" : "gauss-dd-single",
"ha_mode" : "StandSingle",
"engine_name" : "taurus",
"engine_version" : "2.0.51.240300",
"pay_model" : "0",
"create_at" : 1712658210524,
"deleted_at" : 1712659158927,
"volume_type" : "",
"volume_size" : "0",
"data_vip" : "172.16.1.194",
"data_vip_ipv6" : null,
"enterprise_project_id" : "0",
"enterprise_project_name" : "default",
"backup_level" : "2",
"recycle_backup_id" : "70d03dc459304f7298c0f5b49286f37cbr07",
"recycle_status" : "Active",
"recycle_backups" : [ {
"backup_level" : 2,
"backup_id" : "70d03dc459304f7298c0f5b49286f37cbr07",
"backup_name" : "taurus-632423cc56c348bd967b3a03e7abdab9in07-2024112609134619",
"size" : 74678272,
"status" : "Active",
"begin_time" : 1764148420050,
"end_time" : 1764148668780
} ]
} ]
}
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 |
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.gaussdb.v3.region.GaussDBRegion; import com.huaweicloud.sdk.gaussdb.v3.*; import com.huaweicloud.sdk.gaussdb.v3.model.*; public class ListRecycleInstancesSolution { 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); GaussDBClient client = GaussDBClient.newBuilder() .withCredential(auth) .withRegion(GaussDBRegion.valueOf("<YOUR REGION>")) .build(); ListRecycleInstancesRequest request = new ListRecycleInstancesRequest(); try { ListRecycleInstancesResponse response = client.listRecycleInstances(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkgaussdb.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 = GaussDBClient.new_builder() \ .with_credentials(credentials) \ .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListRecycleInstancesRequest() response = client.list_recycle_instances(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/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 := gaussdb.NewGaussDBClient( gaussdb.GaussDBClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListRecycleInstancesRequest{} response, err := client.ListRecycleInstances(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 Code
For details, see Status Codes.
Error Code
For details, 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