云数据库 RDS-查询数据库实例列表:URI

时间:2024-04-01 14:00:38

URI

  • URI格式

    GET /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下的项目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。
    • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询VPC列表

    subnet_id

    String

    子网的网络ID信息,获取方法如下:

    • 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。
    • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表

    offset

    Integer

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

    limit

    Integer

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

    tags

    Array of objects

    根据实例标签键值对进行查询。

    • {key}表示标签键,不可以为空或重复。
    • {value}表示标签值,可以为空。

    如果同时使用多个标签键值对进行查询,中间使用逗号分隔开,最多包含10组。

    详情请参见表2

    表2 tags字段数据结构说明

    名称

    参数类型

    是否必选

    说明

    key

    String

    标签键。长度为1-128个unicode字符。

    可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。

    value

    String

    标签值。最大长度255个unicode字符,可以为空字符串。

    可以包含任何语种字母、数字、空格和_.:=+-@。

support.huaweicloud.com/api-rds/rds_01_0004.html