project_id

String

是

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

id

String

否

参数解释：

实例ID。实例的唯一标识，可根据实例ID查询实例列表。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

name

String

否

参数解释：

实例名称。可根据实例名称查询实例列表。

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

约束限制：

不涉及。

取值范围：

实例名称长度在4~64个字符之间，以字母开头，可以包含字母、数字、中划线或下划线，不能包含其他特殊字符。

默认取值：

不涉及。

type

String

否

参数解释：

实例类型。可根据实例类型查询实例列表。

约束限制：

不涉及。

取值范围：

• Enterprise（区分大小写），对应分布式实例（独立部署）。
• Centralization_standard（区分大小写），对应集中式版实例。

默认取值：

不涉及。

datastore_type

String

否

参数解释：

数据库类型，不区分大小写。可根据数据库类型查询实例列表。

约束限制：

不涉及。

取值范围：

GaussDB 。

默认取值：

不涉及。

vpc_id

String

否

参数解释：

虚拟私有云ID，可按照实例所在的私有云查询实例列表，获取方法如下。

• 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。
• 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

约束限制：

不涉及。

取值范围：

UUID形式。

默认取值：

不涉及。

subnet_id

String

否

参数解释：

子网的网络ID信息。可按照实例所在的子网查询实例列表。

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

约束限制：

不涉及。

取值范围：

UUID形式。

默认取值：

不涉及。

offset

Integer

否

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

不涉及。

取值范围：

[0, 2^31-1]

默认取值：

默认为0（偏移0条数据，表示从第一条数据开始查询）。

limit

Integer

否

参数解释：

查询记录数。

约束限制：

不涉及。

取值范围：

[1, 100]

默认取值：

默认为100。

tags

String

否

参数解释：

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

• {key}表示标签键。
• {value}表示标签值。

约束限制：

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

取值范围：

• {key}最大长度127个unicode字符。key不能为空或者空字符串，不能为空格，使用之前先trim前后半角空格。不能包含+/?#&=,%特殊字符。
• {value}可以为空。最大长度255个unicode字符，使用之前先trim 前后半角空格。不能包含+/?#&=,%特殊字符。如果value为空，则表示any_value（查询任意value）。

默认取值：

不涉及。