文档首页/ 云数据库 GeminiDB/ API参考/ API v3（推荐）/ 备份与恢复/ 查询回收站实例列表
更新时间：2024-08-08 GMT+08:00
查看PDF
分享

查询回收站实例列表

功能介绍

查询回收站所有接口的实例列表。

URI

GET https://{Endpoint}/v3/{project_id}/recycle-instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置，偏移量。

  • 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）
  • 取值必须为数字，且不能为负数。

limit

否

Integer

查询个数上限值。

  • 取值范围：1~100。
  • 不传该参数时，默认查询前100条信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

总记录数。

instances

Array of objects

实例信息。详情请参考表5。
表5 RecycleInstance

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

mode

String

实例类型。

  • 取值为“Cluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis集群实例类型。
  • 取值为“InfluxdbSingle”，表示GeminiDB Influx单节点实例类型。
  • 取值为“ReplicaSet”，表示GeminiDB Mongo副本集实例类型。

datastore

object

数据库信息。详情请参考表6。

charge_mode

String

计费方式。

  • prePaid：预付费，即包年/包月。
  • postPaid：后付费，即按需付费。

enterprise_project_id

String

企业项目ID，取值为“0”，表示为default企业项目。

backup_id

String

备份ID。

created_at

String

实例创建时间。

deleted_at

String

实例删除时间。

retained_until

String

回收备份保留截止时间。
表6 RecycleDatastore

参数

参数类型

描述

type

String

数据库类型。

  • 取值为“cassandra”，表示GeminiDB Cassandra数据库实例。
  • 取值为“mongodb”，表示GeminiDB Mongo数据库实例。
  • 取值为“influxdb”，表示GeminiDB Influx数据库实例。
  • 取值为“redis”，表示GeminiDB Redis数据库实例。

version

String

数据库版本。

请求示例

  • URI样例 
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-instances?offset=0&limit=100
  • 请求体样例

    无。

响应示例

状态码： 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" 
  } ] 
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 备份与恢复