SearchInstances - 查询实例--云原生消息引擎-火山引擎

文档中心

立即注册

导航

SearchInstances - 查询实例

最近更新时间：2024.12.11 19:33:18首次发布时间：2023.07.27 17:33:08

调用 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	Array of 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	Array of Object	否	-	标签过滤器。
PageSize	Integer	是	10	每页能展示的实例数量，默认值为 10。

返回参数

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

参数	类型	示例值	描述
Items	Array of Object	-	返回的实例列表。
PageSize	Integer	10	每页展示的实例数量。
PageCount	Integer	1	总页数。
PageNumber	Integer	1	当前页数。
TotalCount	Long	1	实例总数。

请求示例

GET /?Action=SearchInstances&Version=2023-06-01&ProjectName=default&SearchKey=bmq-test&CreateTimeOrder=DESC HTTP/1.1
Host: bmq.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241112T081805Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=AK********/20241112/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=********

{}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241206162715D5F6B3082815F731****",
        "Action": "SearchInstances",
        "Version": "2023-06-01",
        "Service": "bmq",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "InstanceId": "o-00c0****m46c",
                "ProjectId": "default",
                "Name": "bmq-test",
                "Status": "RUNNING",
                "BillingType": "MIX",
                "Specification": "bmq.standard",
                "MessageRetention": 72,
                "AuthEnabled": false,
                "VpcId": "vpc-mj1u****3o5c5smt1bs88jem",
                "ZoneIdList": [
                    "cn-beijing-c"
                ],
                "Tags": [
                    {
                        "Key": "user",
                        "Value": "doc",
                        "Type": "CUSTOM"
                    }
                ],
                "RegionId": "cn-beijing",
                "ExpirationTime": "2025-12-05T23:59:59",
                "CreateTime": "2024-12-05T15:00:00",
                "ResourceTags": [
                    {
                        "Type": "CUSTOM",
                        "TagKvs": {
                            "user": "doc"
                        }
                    }
                ]
            }
        ],
        "TotalCount": 1,
        "PageCount": 1,
        "PageNumber": 1,
        "PageSize": 10
    }
}

错误码

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

状态码	错误码	错误信息	说明
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	参数编码异常，请联系技术支持或提交工单。