查询回收站实例列表 - QueryingInstancesintheRecycleBin
功能介绍
查询回收站所有接口的实例列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
gaussdbfornosql:instance:listRecycleInstances
List
-
-
nosql:instance:list
-
URI
GET /v3/{project_id}/recycle-instances
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 用户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
offset | 否 | Integer | 参数解释: 索引位置偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 大于或等于0。 取值范围: 不涉及。 默认取值: 0,表示从第一条数据开始查询。 |
limit | 否 | Integer | 参数解释: 查询个数上限值。 约束限制: 不涉及。 取值范围: 1~100。 默认取值: 100。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 | 参数类型 | 描述 |
|---|---|---|
total_count | Integer | 参数解释: 总记录数。 取值范围: 不涉及。 |
instances | Array of objects | 参数解释: 实例信息。详情请参考表5。 取值范围: 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: 实例ID。 取值范围: 不涉及。 |
name | String | 参数解释: 实例名称。 取值范围: 不涉及。 |
mode | String | 参数解释: 实例类型。 取值范围:
|
product_type | String | 参数解释: 产品类型。 取值范围: GeminiDB Redis云原生部署模式集群涉及此字段,取值:
|
data_store | object | 参数解释: 数据库信息。详情请参考表6。 取值范围: 不涉及。 |
charge_type | String | 参数解释: 计费方式。 取值范围:
|
enterprise_project_id | String | 参数解释: 企业项目ID,取值为“0”,表示为default企业项目 取值范围: 不涉及。 |
backup_id | String | 参数解释: 备份ID。 取值范围: 不涉及。 |
created_at | String | 参数解释: 实例创建时间。 取值范围: 不涉及。 |
deleted_at | String | 参数解释: 实例删除时间。 取值范围: 不涉及。 |
retained_until | String | 参数解释: 回收备份保留截止时间。 取值范围: 不涉及。 |
请求示例
响应示例
状态码: 200
Success.
{
"total_count" : 1,
"instances" : [ {
"id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in06",
"name" : "test",
"mode" : "Cluster",
"data_store" : {
"type" : "cassandra",
"version" : "3.11"
},
"charge_type" : "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"
} ]
} 状态码
请参见状态码。
错误码
请参见错误码。

