文档首页> 云数据库 GaussDB> API参考> API(推荐)> 回收站> 查询回收站所有引擎实例列表
更新时间:2024-05-21 GMT+08:00

查询回收站所有引擎实例列表

功能介绍

查询回收站所有引擎实例列表。

URI

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

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

instance_name

String

实例名称。

offset

Integer

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。例如:该参数指定为0,limit指定为10,则只展示第1-10条数据。

limit

Integer

查询记录数。默认为50,不能为负数,最小值为1,最大值为50。例如该参数设定为10,则查询结果最多只显示10条记录。

请求参数

无。

响应参数

表2 参数说明

参数

参数类型

描述

total_count

Integer

总记录数。

instances

Array of objects

回收站所有的实例信息,具体参数请参考表3

表3 instances字段数据结构说明

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

ha_mode

String

部署形态。

枚举值:

  • Ha:主备版。
  • Independent:独立部署。

engine_name

String

引擎名称。

engine_version

String

引擎版本号。

pay_model

String

计费模式。

0:按需计费。

1:包年包月。

created_at

String

创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

deleted_at

String

删除时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

volume_type

String

磁盘类型。

枚举值:

  • high:高IO。
  • ultrahigh:超高IO。
  • essd:急速型SSD。

volume_size

String

磁盘大小。

data_vip

String

数据vip。

enterprise_project_id

String

企业项目ID,"0"代表默认的企业项目。

enterprise_project_name

String

企业项目名称。

backup_level

String

备份级别。

recycle_backup_id

String

备份ID。(指删除实例时产生备份信息中的备份ID)。

recycle_status

String

回收站备份状态。

枚举值:

  • Running:运行中。
  • Active:有效。

mode

String

实例类型。

枚举值:

  • basic:基础版。
  • standard:标准版。
  • enterprise:企业版。

请求示例

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/recycle-instances

响应示例

{ 
  "total_count" : 2, 
  "instances" : [ { 
    "id" : "21f20e55999947a9938ad0453b757e72in14", 
    "name" : "gaussdbv5_CCv20_bms_default_1_20220827012852", 
    "ha_mode" : "Ha", 
    "engine_name" : "gaussdbv5", 
    "engine_version" : "2.3.0", 
    "pay_model" : 0, 
    "created_at" : "2022-08-09T09:26:44.000+08:00", 
    "deleted_at" : "2022-08-09T09:26:44.000+08:00", 
    "volume_type" : "localssd", 
    "volume_size" : "", 
    "data_vip" : "25.213.0.41 / 25.213.0.188 / 25.213.0.101 / 25.213.0.82", 
    "enterprise_project_id" : 0, 
    "enterprise_project_name" : null, 
    "backup_level" : null,
    "recycle_backup_id" : "00b755ed678e41d18c74b28e2ad41bdcbr14", 
    "recycle_status" : "Active", 
    "mode" : "enterprise"
  }, { 
    "id" : "a9df5b52b32e4571b1b6425a78a32956in14", 
    "name" : "ecs-lxy-backup-3", 
    "ha_mode" : "Ha", 
    "engine_name" : "gaussdbv5", 
    "engine_version" : "2.3.0", 
    "pay_model" : 0, 
    "created_at" : "2022-08-09T09:26:44.000+08:00", 
    "deleted_at" : "2022-08-09T09:26:44.000+08:00", 
    "volume_type" : "ultrahigh", 
    "volume_size" : "", 
    "data_vip" : "173.202.10.246 / 173.202.10.205 / 173.202.10.175", 
    "enterprise_project_id" : 0, 
    "enterprise_project_name" : null, 
    "backup_level" : null, 
    "recycle_backup_id" : "ef393704ef0045d1b6226b6f2cdc48a7br14", 
    "recycle_status" : "Active", 
    "mode" : "enterprise"
  } ] 
}

状态码

错误码

请参见错误码