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

时间：2023-11-01 16:19:35

云数据库 GaussDB

URI

URI格式
 GET https://{Endpoint}/v3.1/{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样例
- 查询所有实例列表
   https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/97b026aa9cc4417888c14c84a1ad9860/instances
- 根据指定条件查询实例列表
   https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3.1/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in14&name=hy&type=Enterprise&datastore_type=GaussDB&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	否	按照实例类型查询。目前支持取值如下： Enterprise（区分大小写），对应分布式实例（独立部署）。 Centralization_standard（区分大小写），对应主备版实例。
datastore_type	String	否	数据库类型，不区分大小写。 GaussDB
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	String	否	根据实例标签键值对进行查询。 {key}表示标签键，最大长度127个unicode字符。key不能为空或者空字符串，不能为空格，使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。 {value}表示标签值，可以为空。最大长度255个unicode字符，使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。如果value为空，则表示any_value（查询任意value）。如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，最多包含20组。