QueryConsumerGroupStatus_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

QPS 限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 5。

说明 RAM 用户共享阿里云账号配额。

流控信息

当前云产品API请求速率暂未透出。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

示例值:iot-cn-0pp1n8t****
GroupIdstring

消费组 ID。调用 CreateConsumerGroup 创建消费组成功后,会返回消费组 ID。您可以调用 QueryConsumerGroupList 按消费组名称查询消费组 ID,也可以在物联网平台控制台对应实例下,选择消息转发>服务端订阅>消费组列表,查看消费组 ID。

示例值:nJRaJPn5U1JITGf******参考取值来源:
    CreateDeviceGroup

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
ConsumerSpeedinteger<int32>

消费组消息消费速率,单位:条/分钟。

示例值:14
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:系统异常
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
AccumulatedConsumeCountPerMinuteinteger<int32>

消费组堆积消息消费速率,单位:条/分钟。

示例值:10
LastConsumerTimestring

最近消息消费时间。为 UTC 时间,以毫秒计,格式为“yyyy-MM-dd'T'HH:mm:ss.SSSZ”。

示例值:2020-05-29T03:37:56.000Z
Successboolean

表示是否调用成功。展开详情

示例值:true
RealTimeConsumeCountPerMinuteinteger<int32>

消费组实时消息消费速率,单位:条/分钟。

示例值:14
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:iot.system.SystemException
AccumulationCountinteger<int32>

消费组消息堆积数。

示例值:13
ClientConnectionStatusListobject

返回示例

变更历史

暂无变更历史

相关示例

物联网平台/规则引擎/服务端订阅
2022-02-22