文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 实例管理/ 查询实例列表
更新时间：2024-04-01 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例列表

功能介绍

根据指定条件查询实例列表。

该接口计划于2025-03-31下线，建议及时切换到新接口查询实例列表。

URI

  • URI格式

    GET https://{endpoint}/mysql/v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}

  • URI样例

    GET https://{endpoint}/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10

  • 参数说明
    表1 参数说明

    名称

    参数类型

    是否必选

    说明

    project_id

    String

    是

    租户在某一Region下的project ID。

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

    id

    String

    否

    实例ID。

    “*”为系统保留字符，如果id是以“*”起始，表示按照*后面的值模糊匹配，否则，按照id精确匹配查询。不能只传入“*”

    name

    String

    否

    实例名称。

    “*”为系统保留字符，如果name是以“*”起始，表示按照*后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。

    type

    String

    否

    按照实例类型查询。目前仅支持Cluster。

    datastore_type

    String

    否

    数据库类型，现在只支持gaussdb-mysql。

    vpc_id

    String

    否

    虚拟私有云ID。

    • 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。
    • 方法2：获取方法请参见《虚拟私有云API参考》中“查询VPC列表”的内容。

    subnet_id

    String

    否

    子网的网络ID信息。

    • 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。
    • 方法2：获取方法请参见《虚拟私有云API参考》中“查询子网列表”的内容。

    offset

    Integer

    否

    索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

    limit

    Integer

    否

    查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

请求消息

无。

响应消息

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

    名称

    参数类型

    说明

    instances

    Array of objects

    实例信息。

    详情请参见表3。

    total_count

    Integer

    总记录数。
    表3 instances字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    实例ID。

    name

    String

    创建的实例名称。

    status

    String

    实例状态。

    private_ips

    List<String>

    实例写内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空字符串。

    public_ips

    List<String>

    实例外网IP地址列表。

    port

    String

    数据库端口号。

    type

    String

    实例类型，取值为“Cluster”。

    region

    String

    实例所在区域。

    datastore

    Object

    数据库信息。

    详情请参见表5。

    created

    String

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

    其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。

    说明：创建时返回值为空，数据库实例创建成功后该值不为空。

    updated

    String

    更新时间，格式与“created”字段对应格式完全相同。

    说明：创建时返回值为空，数据库实例创建成功后该值不为空。

    db_user_name

    String

    默认用户名。

    vpc_id

    String

    虚拟私有云ID。

    subnet_id

    String

    子网的网络ID信息。

    security_group_id

    String

    安全组ID。

    flavor_ref

    String

    规格码。

    详情请参见表3。

    flavor_info

    Object

    规格说明。

    volume

    Object

    Volume信息。

    详情请参见表6。

    backup_strategy

    Object

    备份策略。

    详情请参见表7。

    enterprise_project_id

    String

    企业项目ID。

    time_zone

    String

    时区。

    charge_info

    Object

    计费类型信息，支持包年包月和按需，默认为按需。

    详情请参见表8。
    表4 datastore字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    数据库引擎。

    version

    String

    数据库版本。
    表5 volume字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    磁盘类型。

    size

    String

    已使用磁盘大小，单位GB。
    表6 flavor_ref字段数据结构说明

    名称

    参数类型

    说明

    vcpus

    String

    CPU核数。

    ram

    String

    内存大小，单位GB。
    表7 backup_strategy字段数据结构说明

    名称

    参数类型

    说明

    start_time

    String

    备份时间段。自动备份将在该时间段内触发。

    keep_days

    String

    已生成的备份文件可以保存的天数。
    表8 charge_info字段数据结构说明

    名称

    参数类型

    说明

    charge_mode

    String

    计费模式。

    取值范围：

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

    响应样例中，“region”的值为示例值。

  • 正常响应样例 
    {
    "total_count":6,
    "instances":[
        {
            "id":"d738399de028480fabb2b8120d4e01a4in07",
            "status":"ACTIVE",
            "name":"oMoS_001",
            "port":3306,
            "type":"Cluster",
            "private_ips": ["192.168.0.142"],
            "public_ips": ["10.154.219.187"],
            "db_user_name": "root",
            "region": "aaa",
            "datastore": {"type": "gaussdb-mysql", "version":"8.0"},
            "created": "2018-08-20T02:33:49+0800",
            "updated": "2018-08-20T02:33:50+0800",
            "volume": {
                    "type": "POOL",
                    "used_size": 100
            },                         
            "vpc_id": "f7ee62e2-9705-4523-ba49-a85ea1a1fa87",
            "subnet_id": "140af7bf-a9da-4dcf-8837-34199fd6d186",
            "security_group_id":"c7f69884-fe2b-4630-8114-70a11499d902",
            "flavor_ref":"gaussdb.mysql.c3.small.4",
            "backup_strategy": {"start_time": "19:00-20:00", "keep_days": 7},                          
            "charge_info": {
                "charge_mode": "postPaid"
            },
            "enterprise_project_id": "0",
                 "time_zone": ""，
        }
    ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理