更新时间:2022-02-22 GMT+08:00

查询数据库实例列表

功能介绍

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

URI

  • URI格式

    GET https://{Endpoint}/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}&tags={key}={value}

  • 参数说明
    表1 参数说明

    名称

    参数类型

    是否必选

    说明

    project_id

    String

    租户在某一region下的project ID。

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

    id

    String

    实例ID。

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

    name

    String

    实例名称。

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

    type

    String

    按照实例类型查询。取值Single、Ha、Replica、Enterprise,分别对应于单实例、主备实例和只读实例、分布式实例(企业版)。

    datastore_type

    String

    数据库类型,区分大小写。

    • MySQL
    • PostgreSQL
    • SQLServer

    vpc_id

    String

    虚拟私有云ID。

    • 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。

    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

    实例状态。

    取值:

    值为“BUILD”,表示实例正在创建。

    值为“ACTIVE”,表示实例正常。

    值为“FAILED”,表示实例异常。

    值为“MODIFYING”,表示实例正在扩容。

    值为“REBOOTING”,表示实例正在重启。

    值为“RESTORING”,表示实例正在恢复。

    值为“MODIFYING INSTANCE TYPE”,表示实例正在转主备。

    值为“SWITCHOVER”,表示实例正在主备切换。

    值为“MIGRATING”,表示实例正在迁移。

    值为“BACKING UP”,表示实例正在进行备份。

    值为“MODIFYING DATABASE PORT”,表示实例正在修改数据库端口。

    private_ips

    List<String>

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

    private_dns_names

    List<String>

    实例内网域名列表。实例创建成功后,需要手动申请内网域名,否则查询内网域名为空。

    public_ips

    List<String>

    实例外网IP地址列表。

    port

    Integer

    数据库端口号。

    • MySQL数据库端口设置范围为1024~65535(其中12017和33071被RDS系统占用不可设置)。
    • PostgreSQL数据库端口修改范围为2100~9500。
    • Microsoft SQL Server实例的端口设置范围为1433和2100~9500(其中5355和5985不可设置)。

    当不传该参数时,默认端口如下:

    • MySQL默认3306。
    • PostgreSQL默认5432。
    • Microsoft SQL Server默认1433。

    type

    String

    实例类型,取值为“Single”,“Ha”或“Replica”, "Enterprise",分别对应于单机实例、主备实例、只读实例、分布式实例(企业版)。

    ha

    Object

    HA信息,获取HA实例时返回。

    详情请参见表4

    region

    String

    实例所在区域。

    datastore

    Object

    数据库信息。

    详情请参见表5

    created

    String

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

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

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

    updated

    String

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

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

    db_user_name

    String

    默认用户名。

    vpc_id

    String

    虚拟私有云ID。

    subnet_id

    String

    子网的网络ID信息。

    security_group_id

    String

    安全组ID。

    flavor_ref

    String

    规格码。

    volume

    Object

    Volume信息。

    详情请参见表6

    switch_strategy

    String

    数据库切换策略。取值为“reliability”或“availability”,分别对应于可靠性优先和可用性优先。

    backup_strategy

    Object

    备份策略。

    详情请参见表7

    maintenance_window

    String

    可维护时间窗,为UTC时间。

    nodes

    Array of objects

    主备实例信息。

    详情请参见表8

    related_instance

    Array of objects

    所关联的数据库实例列表。

    详情请参见表9

    time_zone

    String

    时区。

    表4 ha字段数据结构说明

    名称

    参数类型

    说明

    replication_mode

    String

    备机同步参数。

    取值:非空。

    • MySQL为“async”或“semisync”。
    • PostgreSQL为“async”或“sync”。
    • Microsoft SQL Server为“sync”。
    说明:
    • “async”为异步模式。
    • “semisync”为半同步模式。
    • “sync”为同步模式。
    表5 datastore字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    数据库引擎。

    version

    String

    数据库版本。

    表6 volume字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    磁盘类型。

    size

    Integer

    磁盘大小。

    表7 backup_strategy字段数据结构说明

    名称

    参数类型

    说明

    start_time

    String

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

    当前时间指UTC时间。

    keep_days

    Integer

    已生成的备份文件可以保存的天数。

    取值范围:0~732。为0时,表示未设置自动备份策略或备份策略已关闭。如果需要延长保留时间请联系客服人员申请,自动备份最长可以保留2562天。

    表8 nodes字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    节点ID。

    name

    String

    节点名称。

    role

    String

    节点类型,取值为“master”、“slave”或“readreplica”,分别对应于主节点、备节点和只读节点。

    status

    String

    节点状态。

    availability_zone

    String

    可用区。

    表9 related_instance字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    关联实例id。

    type

    String

    关联实例类型。

    • “replica_of”对应于“主实例”。
    • “replica”对应于“只读实例”。
  • 正常响应样例

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

状态码

请参见状态码

错误码

请参见错误码