GetConsumerList_云消息队列 Kafka 版_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.

流控信息

请求速率为100/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
alikafka:ListGroup
Get
全部资源
*

请求参数

字段名称字段详情
InstanceIdstring

Group 所属实例的 ID。

示例值:alikafka_post-cn-v0h18sav****参考取值来源:
    GetAllInstanceIdList
    CreatePrePayInstance
RegionIdstring

Group 所属实例的地域 ID。

示例值:cn-hangzhou
CurrentPageinteger<int32>

当前页面。

示例值:1
PageSizeinteger<int32>

每页显示的消费组数。

示例值:10
ConsumerIdstring

指定 Group 的 ID。如果不指定,则查询所有 Group。

示例值:kafka-test参考取值来源:
    CreateConsumerGroup

返回参数

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

返回码。返回 200 代表成功。

示例值:200
Messagestring

返回信息。

示例值:operation success.
RequestIdstring

请求 ID。

示例值:808F042B-CB9A-4FBC-9009-00E7DDB6****
Successboolean

调用是否成功。

示例值:true
ConsumerListobject
Totalinteger<int64>

总数量。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:12
PageSizeinteger<int32>

每页显示的条数。

示例值:10
CurrentPageinteger<int32>

指定显示返回结果中的第几页,最小值为 1。

示例值:1

返回示例

变更历史

变更时间变更内容概要操作
2024-12-06
变更返回参数
2024-03-20
新增错误码400
新增请求参数CurrentPage
新增请求参数PageSize
删除返回参数
2022-12-27
变更返回参数
2022-12-27
变更返回参数

相关示例

调用GetConsumerList获取Group信息。
2021-09-14