文档中心

云原生消息引擎

实例管理

DescribeInstanceResourceStat - 查询单个实例资源

调用 DescribeInstanceResourceStat 参数，查询 BMQ 实例所包含的资源，支持统计 Topic、Group 和分区的数量。

请求说明

请求方式：GET

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

调试

API Explorer

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

去调试

请求参数

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

Action string 必选示例值：DescribeInstanceResourceStat

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

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

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

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

需要查询的 BMQ 实例 ID。一次只能查询一个实例。

WithTopic boolean 可选示例值：true

是否统计Topic数量，取值如下：

true：统计。

false：默认值，不统计。

WithGroup boolean 可选示例值：true

是否统计消费组数量，取值如下：

true：统计。

false：默认值，不统计。

WithPartition boolean 可选示例值：true

是否统计分区数量，取值如下：

true：统计。

false：默认值，不统计。

返回参数

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

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

BMQ 实例 ID。

TotalGroups integer 示例值：0

实例内消费组数量。

TotalTopics integer 示例值：1

实例 Topic 数量。

TotalPartitions integer 示例值：3

实例内分区数量。

请求示例

GET /?Action=DescribeInstanceResourceStat&Version=2023-06-01&InstanceIds=o-00c0****m46c&WithTopic=true&WithGroup=true&WithPartition=true HTTP/1.1​
Host: bmq.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20241112T033344Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241112/cn-beijing/bmq/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{}​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "2024110421152821321617616418****",​
    "Action": "DescribeInstanceResourceStat",​
    "Version": "2023-06-01",​
    "Service": "bmq",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "InstanceId": "o-00c0****m46c",​
    "TotalGroups": 0,​
    "TotalTopics": 1,​
    "TotalPartitions": 3​
  }​
}​

错误码

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

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

最近更新时间：2025.08.05 18:34:38

这个页面对您有帮助吗？

有用

无用