GetKafkaClientIp
获取kafka客户端ip
服务地址:
华东1 金融云
输入参数
只看必填
RegionId实例所属的地域 ID
InstanceId实例ID
TopicTopic名称
Group消费组ID
Type查询客户端 IP 类型
StartTime起始时间
EndTime结束时间
插件下载了解更多
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.

接口说明

  • 统计的 IP 信息是从客户端通过 Kafka 的 API 请求到服务端的采样日志中获取的。

  • 统计数量表示服务端在您指定的时间范围内,统计到的同一个 IP 不同端口的连接个数。

  • 如果您的服务端小版本不是最新版本,会导致采样日志不够精确,最终导致统计的 IP 信息不够精准。因此建议您尽快升级服务端小版本。

请求参数

字段名称字段详情
RegionIdstring

实例所属的地域 ID。

示例值:cn-hangzhou
InstanceIdstring

实例 ID。

示例值:alikafka_post-cn-v0h1fgs2****参考取值来源:
    GetAllInstanceIdList
    CreatePrePayInstance
Topicstring

Topic 名称。展开详情

示例值:topic_name参考取值来源:
    CreateTopic
    GetTopicList
Groupstring

消费组 ID。展开详情

示例值:group_name参考取值来源:
    ChangeResourceGroup
Typestring

查询客户端 IP 类型。可选择三种方式查询。展开详情

示例值:byInstance枚举值:byInstancebyTopicbyGroup
StartTimeinteger<int64>

起始时间。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1716343501000
EndTimeinteger<int64>

结束时间。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1716343502000

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:E57A8862-DF68-4055-8E55-B80CB4****
Successboolean

请求是否成功。

示例值:true
Codeinteger<int64>

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

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

返回结果的提示信息。

示例值:operation success.
Dataobject

返回结果。

变更历史
变更时间变更内容概要操作
2024-11-14
新增OpenAPI,查询 Kafka 客户端IP