更新时间:2024-08-09 GMT+08:00
分享

查询回收站实例信息

功能介绍

查询回收站实例信息。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    GET /v3/{project_id}/recycle-instances?offset={offset}&limit={limit}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

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

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

    offset

    索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,必须为数字,不能为负数。

    limit

    每页数据条数,取值范围[1, 50]。

请求消息

  • 参数说明

    无。

  • URI样例

    GET https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/recycle-instances?offset=0&limit=10

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    total_count

    Integer

    回收站数据条数。

    instances

    Array of objects

    回收站信息,详细说明请参见表3

    表3 instances字段数据结构说明

    参数

    参数类型

    描述

    id

    String

    实例ID。

    name

    String

    实例名称。

    ha_mode

    String

    实例主备模式,取值:Ha(主备)、Single(单机),不区分大小写。

    engine_name

    String

    引擎名称。

    engine_version

    String

    数据库引擎版本。

    pay_model

    String

    计费方式,取值:0(按需)、1(包周期)。

    created_at

    String

    创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

    deleted_at

    String

    删除时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

    volume_type

    String

    磁盘类型。取值范围如下,区分大小写:

    • ULTRAHIGH,表示超高IO型磁盘。
    • ULTRAHIGHPRO,表示SSD尊享版,仅支持超高性能型尊享版(需申请权限)。
    • CLOUDSSD,表示SSD云盘,仅支持通用型和独享型规格实例。
    • LOCALSSD,表示本地SSD盘。

    volume_size

    Integer

    磁盘大小,单位为GB。取值范围:40GB~4000GB,必须为10的整数倍。

    部分用户支持40GB~6000GB,如果您想创建存储空间最大为6000GB的数据库实例,或提高扩容上限到10000GB,请联系客服开通。

    对于只读实例,该参数无效,只读实例磁盘大小默认和主实例相同。

    data_vip

    String

    内网地址。

    data_vip_v6

    String

    IPv6内网地址。

    enterprise_project_id

    String

    企业项目ID。

    retained_until

    String

    保留时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

    recycle_backup_id

    String

    备份ID。

    recycle_status

    String

    备份状态取值如下,区分大小写:

    • BUILDING:备份中,不能进行重建。
    • COMPLETED:备份完成,可以重建实例。

    is_serverless

    Boolean

    实例类型。

    • true:表示Serverless实例。
    • false:表示非Serverless实例。
  • 正常响应样例
    {
      "total_count" : 2, 
      "instances" : [ { 
        "id" : "b7dea08c0f0e4fed9f1951fff9013639in01", 
        "name" : "rds-8b86", 
        "ha_mode" : "Ha", 
        "engine_name" : "mysql", 
        "engine_version" : "5.7.38", 
        "pay_model" : "0", 
        "created_at" : "2022-12-26T03:38:10+0000", 
        "deleted_at" : "2023-01-09T08:57:10+0000", 
        "volume_type" : "SSD", 
        "volume_size" : 80, 
        "data_vip" : "192.168.226.188", 
        "enterprise_project_id" : "0", 
        "retained_until" : "2023-01-16T09:20:48+0000", 
        "recycle_backup_id" : "e8e3c329c20442f5aec21b95a8cdaa52br01", 
        "recycle_status" : "COMPLETED",
        "is_serverless" : false
      }, { 
        "id" : "cc6d0dff4a9145d0a1335c35a866de23in01", 
        "name" : "rds-82b2", 
        "ha_mode" : "Ha", 
        "engine_name" : "mysql", 
        "engine_version" : "5.7.38", 
        "pay_model" : "0", 
        "created_at" : "2022-12-26T06:17:58+0000", 
        "deleted_at" : "2023-01-09T08:56:49+0000", 
        "volume_type" : "SSD", 
        "volume_size" : 200, 
        "data_vip" : "192.168.2.24", 
        "enterprise_project_id" : "0", 
        "retained_until" : "2023-01-16T09:20:45+0000", 
        "recycle_backup_id" : "3f35a348ae0943979bd302a9788f49e7br01", 
        "recycle_status" : "COMPLETED",
        "is_serverless" : false
      } ] 
    }

状态码

错误码

请参见错误码

相关文档