ListInstanceResourceStats - 查询多个实例资源--云原生消息引擎-火山引擎

文档中心

立即注册

导航

ListInstanceResourceStats - 查询多个实例资源

最近更新时间：2024.12.11 16:59:15首次发布时间：2023.09.27 10:47:49

调用 ListInstanceResourceStats 接口，同时查询多个 BMQ 实例所包含的资源。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListInstanceResourceStats	要执行的操作，取值：ListInstanceResourceStats。
Version	String	是	2023-06-01	API的版本，取值：2023-06-01。
InstanceIds	String	是	o-00c0**m46c,o-00c0**vq7c	需要查询的 BMQ 实例 ID，多个实例 ID 之间使用英文逗号（,）分隔。
WithTopic	Boolean	否	true	是否统计 Topic 数量，取值如下： ture：统计。 false：不统计。
WithGroup	Boolean	否	true	是否统计消费组数量，取值如下： ture：统计。 false：不统计。
WithPartition	Boolean	否	false	是否统计分区数量，取值如下： ture：统计。 false：不统计。

返回参数

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

参数	类型	示例值	描述
Items	Array of Object	[ { "InstanceId": "o-00c0****m46c, "TotalGroups": 0, "TotalTopics": 0, "TotalPartitions": 12 } ]	实例的资源详情。

请求示例

GET /?Action=ListInstanceResourceStats&Version=2023-06-01&&Version=2023-06-01&InstanceIds=o-00c0****m46c&WithTopic=true&WithGroup=true HTTP/1.1
Host: bmq.volcengineapi.com
X-Date: 20241104T131615Z
Authorization: HMAC-SHA256 Credential=AK********/20241104/cn-beijing/bmq/request, SignedHeaders=host;x-date, Signature=********

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241104211619134162098208AB****",
    "Action": "ListInstanceResourceStats",
    "Version": "2023-06-01",
    "Service": "bmq",
    "Region": "cn-beijing"
  },
  "Result": {
    "Items": [
      {
        "InstanceId": "o-00c0****m46c,
        "TotalGroups": 0,
        "TotalTopics": 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	参数编码异常，请联系技术支持或提交工单。