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

时间:2023-11-01 16:20:15

URI

GET /v3/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。

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

表2 Query参数

参数

是否必选

参数类型

描述

id

String

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

name

String

实例名称。

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

type

String

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

datastore_type

String

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

vpc_id

String

虚拟私有云ID。

subnet_id

String

子网的网络ID信息。

private_ip

String

读写内网IP。

readonly_private_ip

String

读内网IP。

proxy_ip

String

读写分离IP。

offset

Integer

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

limit

Integer

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

tags

String

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

  • {key}表示标签键。

  • {value}表示标签值。

如果同时使用多个标签键值对进行查询,中间使用逗号分隔开,表示查询同时包含指定标签键值对的实例。key不能重复,key之间是与的关系。

support.huaweicloud.com/api-gaussdb/ListGaussMySqlInstances.html