Querying Instances in the Recycle Bin
Function
This API is used to query all instances in the recycle bin.
URI
GET https://{Endpoint}/v3/{project_id}/recycle-instances
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Index offset.
|
limit |
No |
Integer |
Maximum records to be queried.
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_count |
Integer |
Total number of records. |
instances |
Array of objects |
Instance information. For details, see Table 5. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
name |
String |
Instance name. |
mode |
String |
Instance type. The value can be:
|
datastore |
object |
Database information For details, see Table 6. |
charge_mode |
String |
Billing mode. Options:
|
enterprise_project_id |
String |
Enterprise project ID. The value 0 indicates that the default enterprise project is used. |
backup_id |
String |
Backup ID. |
created_at |
String |
Instance creation time. |
deleted_at |
String |
Instance deletion time. |
retained_until |
String |
Retention end time. |
Parameter |
Type |
Description |
---|---|---|
type |
String |
Database type. The value can be:
|
version |
String |
Database version. The value can be: |
Example Requests
Example Responses
Status code: 200
Success
{ "total_count" : 1, "instances" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in06", "name" : "test", "mode" : "Cluster", "datastore" : { "type" : "cassandra", "version" : "3.11" }, "charge_mode" : "postPaid", "enterprise_project_id" : "0", "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", "created_at" : "2022-01-01T10:00:00", "deleted_at" : "2022-02-01T11:00:00", "retained_until" : "2022-02-02T11:00:00" } ] }
Status Codes
For details, see Status Codes.
Error Codes
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.