查询Consumer Group的消费状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
alikafka:ListGroup | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 | alikafka_pre-cn-mp919o4v**** |
ConsumerId | string | 是 | Group 的名称。 | kafka-test |
RegionId | string | 是 | 实例的地域 ID。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": 200,
"Message": "operation success.",
"RequestId": "252820E1-A2E6-45F2-B4C9-1056B8CE****",
"Success": true,
"ConsumerProgress": {
"LastTimestamp": 1566874931671,
"TotalDiff": 0,
"TopicList": {
"TopicList": [
{
"TotalDiff": 0,
"LastTimestamp": 1566874931649,
"Topic": "kafka-test",
"OffsetList": {
"OffsetList": [
{
"Partition": 0,
"BrokerOffset": 9,
"ConsumerOffset": 9,
"LastTimestamp": 1566874931649
}
]
}
}
]
},
"RebalanceInfoList": {
"RebalanceInfoList": [
{
"Generation": 100,
"LastRebalanceTimestamp": 1709199270,
"Reason": "removing member consumer-1-cd14eb9c-379b-4b8e-9bbd-76f147f8536f on LeaveGroup",
"GroupId": "falcon-uat",
"RebalanceTimeConsuming": 1,
"RebalanceSuccess": true
}
]
}
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Sls.Query.Error | Data query failed. Please try again later. | 数据查询失败,请稍后重试。 |
400 | AgentError | A system exception occurred. Please submit a ticket. | 内部错误,请提交工单。 |
400 | AgentBusinessError | Internal error, please try again, if invalid, please submit the work order. | 内部错误,请重试,若无效请提交工单。 |
400 | InvalidParameter | The %s parameter is invalid. | 参数%s校验不通过 |
404 | InstanceAgent.NotFound | Instance does not exist. Please check the entry and try again. | Instance 不存在,请核实入参后重试。 |
404 | InvalidParameter.DataNotFound | No data found for the %s parameter. | 参数%s查找不到数据 |
访问错误中心查看更多错误码。