You need to enable JavaScript to run this app.
文档中心
消息队列 Kafka版

消息队列 Kafka版

复制全文
下载 pdf
操作审计
DescribeOffsetCommitAuditInfo - 查询消费位点提交审计信息
复制全文
下载 pdf
DescribeOffsetCommitAuditInfo - 查询消费位点提交审计信息
调用 DescribeOffsetCommitAuditInfo 接口,查询实例内消费位点提交的客户端连接记录。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeOffsetCommitAuditInfo​
要执行的操作,取值:DescribeOffsetCommitAuditInfo。​
​
Version string 必选 示例值:2022-05-01​
API 的版本,取值:2022-05-01。​
​
PageNumber integer 必选 示例值:1​
查询的分页编码。​
​
PageSize integer 必选 示例值:10​
查询的分页大小。​
​
InstanceId string 必选 示例值:kafka-xxx​
实例 ID。​
​
Type string 必选 示例值:GroupTopic​
查询范围。取值如下:​
  • All:查询实例内全部 Consumer Group,ConsumerGroup 和 Topic 必须为空。​
  • Group:查询指定 Consumer Group,ConsumerGroup 必填且 Topic 必须为空。​
  • GroupTopic:查询指定 Consumer Group 和 Topic,ConsumerGroup 和 Topic 均必填。​
​
ConsumerGroup string 可选 示例值:order-consumer-group​
Consumer Group 名称。Type 为 Group 或 GroupTopic 时必填;Type 为 All 时必须为空。​
​
Topic string 可选 示例值:order-events​
Topic 名称。Type 为 GroupTopic 时必填;Type 为 All或 Group 时必须为空。​
​
SourceIp string 可选 示例值:192.168​
过滤使用的源端 IP。模糊匹配。默认不过滤。​
​
SourcePort string 可选 示例值:23​
过滤使用的源端端口。模糊匹配。默认不过滤。​
​
SortOrder string 可选 示例值:Desc​
结果根据最近提交时间排序。默认为降序排列。取值如下:​
  • Desc:降序。​
  • Asc:升序。​
​
AggregateBySourceIp boolean 可选 示例值:false​
是否按照 IP 聚合。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Total integer 示例值:1​
符合查询条件的结果总数。​
​
Records object[] 示例值:--​
查询页的结果。​
ConsumerGroup string 示例值:order-consumer-group​
Consumer Group名称。​
​
Topics string[] 示例值:["order-events","order-result"]​
该连接提交过消费位点的 Topic 列表。​
​
SourceIp string 示例值:192.168.0.1​
连接对应的源 IP 地址。​
​
SourcePort integer 示例值:12345​
连接对应的源端口。​
​
LastUpdateTime string 示例值:2026-10-21T12:05:14Z​
最近提交消费位点的时间。​
​
CreateTime string 示例值:2026-10-21T12:05:11Z​
连接建立的时间。​
​
CloseTime string 示例值:2026-10-22T12:05:11Z​
连接关闭的时间。可能为空,表示当前连接仍在持续。​
​
​
​
​
请求示例​
​
POST /?Action=DescribeOffsetCommitAuditInfo&Version=2022-05-01 HTTP/1.1​
Host: kafka.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20261021T102305Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20261021/cn-beijing/Kafka/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"PageNumber": 1,​
"PageSize": 10,​
"InstanceId": "kafka-xxx",​
"Type": "GroupTopic",​
"ConsumerGroup": "order-consumer-group",​
"Topic": "order-events"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20261021200531860139816C6D***B7-e7b570",​
"Action": "DescribeOffsetCommitAuditInfo",​
"Version": "2022-05-01",​
"Service": "Kafka",​
"Region": "cn-beijing"​
},​
"Result": {​
"Records": [​
{​
"ConsumerGroup": "order-consumer-group",​
"Topics": [​
"order-events"​
],​
"SourceIp": "11.1xx.xx.1",​
"SourcePort": 58950,​
"LastUpdateTime": "2026-10-21T12:05:14Z",​
"CreateTime": "2026-10-21T12:05:11Z",​
"CloseTime": ""​
}​
],​
"Total": 1​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter.PageNumber​
The specified parameter PageNumber is not valid.​
参数值 PageNumber 无效,请检查后重试。​
400​
InvalidParameter.PageSize​
The specified parameter PageSize is not valid.​
参数值 PageSize 无效,请检查后重试。​
400​
InvalidParameter.Type​
The specified parameter Type is not valid.​
参数值 Type 无效,请检查后重试。​
400​
InvalidParameter.ConsumerGroup​
The specified parameter ConsumerGroup is not valid.​
参数值 ConsumerGroup 无效或与 Type 不匹配,请检查后重试。​
400​
InvalidParameter.Topic​
The specified parameter Topic is not valid.​
参数值 Topic 无效或与 Type 不匹配,请检查后重试。​
​
​
最近更新时间:2026.10.28 15:39:30
这个页面对您有帮助吗?
有用
有用
无用
无用