文档首页/ 分布式消息服务Kafka版/ API参考/ API V2（推荐）/ 日志管理/ 查询日志任务 - ShowKafkaLogTask
更新时间：2026-04-16 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询日志任务 - ShowKafkaLogTask

功能介绍

查询日志任务。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/kafka/instances/{instance_id}/logs/{log_type}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

log_type

是

String

参数解释：

日志任务类型。

约束限制：

不涉及。

取值范围：

  • REBALANCE：重平衡日志。

  • topic_log：Topic日志。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

log_response_list

Array of ShowKafkaLogTaskEntity objects

参数解释：

日志响应列表。
表3 ShowKafkaLogTaskEntity

参数

参数类型

描述

id

String

参数解释：

日志记录ID。

取值范围：

不涉及。

instance_id

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

取值范围：

不涉及。

log_group_id

String

参数解释：

日志组ID。

取值范围：

不涉及。

log_stream_id

String

参数解释：

日志流ID。

取值范围：

不涉及。

dashboard_id

String

参数解释：

仪表盘ID。

取值范围：

不涉及。

status

String

参数解释：

状态。

取值范围：

  • OPEN：开启。

  • CLOSE：关闭。

  • CLOSING：关闭中。

  • OPENING：开启中。

log_type

String

参数解释：

状态。

取值范围：

  • REBALANCE：重平衡日志。

  • topic_log：Topic日志。

log_file_name

String

参数解释：

日志文件名。

取值范围：

不涉及。

created_at

Long

参数解释：

创建时间。

取值范围：

不涉及。

updated_at

Long

参数解释：

更新时间。

取值范围：

不涉及。

请求示例

GET https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/logs/topic_log

响应示例

状态码：200

查询日志任务成功。

{
  "log_response_list" : [ {
    "id" : "8abfa7b39cbbfbbb019cbd30596b3cc0",
    "instance_id" : "c0dbb06c-xxxx-xxxx-xxxx-f0ee2fe223aa",
    "log_group_id" : null,
    "log_stream_id" : null,
    "dashboard_id" : null,
    "status" : "CLOSE",
    "log_type" : "topic_log",
    "log_file_name" : "topic.log",
    "created_at" : null,
    "updated_at" : null
  } ]
}

状态码

状态码

描述

200

查询日志任务成功。

错误码

请参见错误码。

父主题： 日志管理