调用 SearchInstances 接口，查询符合条件的 BMQ 实例列表。

请求说明

请求方式：GET

请求地址：https://open.volcengineapi.com?Action=SearchInstances&Version=2023-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：SearchInstances

要执行的操作，取值：SearchInstances。

Version string 必选示例值：2023-06-01

API的版本，取值：2023-06-01。

ProjectName string 可选示例值：default

实例所属项目名称。

SearchKey string 可选示例值：bmq-test

根据实例名称的关键字进行模糊搜索。

Status string[] 可选示例值：RUNNING

根据实例的状态进行搜搜。支持同时设置多个状态，以英文逗号（,）分隔。

取值如下：

INITIALIZING：初始化中

INITIALIZATION_FAILED：初始化失败

RUNNING：运行中

MODIFYING：更新中

MODIFY_FAILED：更新失败

RELEASING：释放中

STOPPING：停止中

STOPPED：停止

RECOVERING：恢复中

EXCEPTION：异常

CAPACITY_EXPAXION_FAILED：扩容失败

EXPANDING_CAPACITY：扩容中

CANCEL_EXPANDING_CAPACITY：扩容取消中

RESTARTING：重启中

UNPAID：未支付

CreateTimeOrder string 可选示例值：DESC

按照实例的创建时间排序。支持以下排序方式：

DESC：默认值，降序排列

ASC：升序排列

PageNumber integer 必选示例值：1

页数，默认值为 1。

TagFilters object[] 可选示例值：\-

标签过滤器。

Key string 可选示例值：user

标签键。

Values string[] 可选示例值：doc

标签值。

PageSize integer 必选示例值：10

每页能展示的实例数量，默认值为 10。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Items object[] 示例值：\-

返回的实例列表。

Name string 示例值：bmq-test

实例名称。

Tags object[] 示例值：[ {"Key": "user", "Value": "doc", "Type": "CUSTOM" } ]

实例资源标签列表。

Key string 示例值：user

标签键。

Type string 示例值：CUSTOM

实例标签的类型，取值如下：

CUSTOM：自定义设置标签。

SYSTEM：系统标签。

Value string 示例值：doc

标签值。

VpcId string 示例值：vpc-mj1u****3o5c5smt1bs88jem

实例所在 VPC。

Status string 示例值：RUNNING

实例状态。

RegionId string 示例值：cn-beijing

实例所在地域。

CreateTime string 示例值：2024-12-05T15:00:00

实例创建时间。

InstanceId string 示例值：o-00c0****m46c

实例 ID。

ZoneIdList string[] 示例值：["cn-beijing-c"]

实例所在可用区 ID 列表。

AuthEnabled boolean 示例值：false

是否开启内网认证，取值如下：

true：开启认证。

false：不开启认证。

BillingType string 示例值：MIX

实例的计费方式，取值如下：

POST：按量计费

MIX：包年包月

Description string 示例值：测试使用

实例的描述。

ResourceTags object[] 示例值：[{ "Type": "CUSTOM", "TagKvs": { "user": "doc"} }]

实例资源标签列表。

Type string 示例值：CUSTOM

标签类型，取值如下：

CUSTOM：自定义设置标签。

SYSTEM：系统标签。

TagKvs object 示例值：{ "Type": "CUSTOM", "TagKvs": {"user": "doc"} }

标签键值对。

Specification string 示例值：bmq.standard

实例规格。

如需详细了解实例规格，请参见实例规格。

ExpirationTime string 示例值：2025-12-05T23:59:59

实例的过期时间。

MessageRetention integer 示例值：72

实例下所有 Topic 的默认消息保留时长，单位为小时。

PageSize integer 示例值：10

每页展示的实例数量。

PageCount integer 示例值：1

总页数。

PageNumber integer 示例值：1

当前页数。

TotalCount long 示例值：1

实例总数。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	InvalidParameter	parameter is invalid, pls check parameters	参数值无效。
200	Unauthorized	authorized error	授权错误，请授权或切换账号后重试。
200	InternalServiceError	internal service error, please contact with admin	内部服务错误，请联系技术支持或提交工单。
200	DatabaseError	database error	数据库错误。
200	ParameterEncodingError	Failure encoding object into query map	参数编码异常，请联系技术支持或提交工单。

云原生消息引擎