调用 DescribeInstanceResourceStat 参数，查询 BMQ 实例所包含的资源，支持统计 Topic、Group 和分区的数量。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | DescribeInstanceResourceStat | 要执行的操作，取值：DescribeInstanceResourceStat。 |
Version | String | 是 | 2023-06-01 | API的版本，取值：2023-06-01。 |
InstanceId | String | 是 | o-00c0****m46c | 需要查询的 BMQ 实例 ID。一次只能查询一个实例。 |
WithTopic | Boolean | 否 | true | 是否统计Topic数量，取值如下：
|
WithGroup | Boolean | 否 | true | 是否统计消费组数量，取值如下：
|
WithPartition | Boolean | 否 | true | 是否统计分区数量，取值如下：
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
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 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。