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

开启日志任务 - StartKafkaLogTask

功能介绍

开启日志任务。

调用方法

请参见如何调用API。

授权信息

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

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

URI

POST /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日志。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

log_task_list

否

Array of StartKafkaLogTaskReqEntity objects

参数解释：

日志任务列表。
表3 StartKafkaLogTaskReqEntity

参数

是否必选

参数类型

描述

log_file_name

否

String

参数解释：

日志文件名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

log_group_name

否

String

参数解释：

日志组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

log_stream_name

否

String

参数解释：

日志流名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

job_id

String

参数解释：

开启日志任务ID。

取值范围：

不涉及。

请求示例

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

{
  "log_task_list" : [ {
    "log_file_name" : "topic.log",
    "log_group_name" : "rabbitmq_run_log_4778553c-xxxx-xxx-xxxx-f58555488d09",
    "log_stream_name" : "channel.log_4778553c-xxxx-xxx-xxxx-f58555488d09"
  } ]
}

响应示例

状态码：200

开启日志任务成功。

{
  "job_id" : "ff8080828bdc0f64018bdcadfd8f00d7"
}

状态码

状态码

描述

200

开启日志任务成功。

错误码

请参见错误码。

父主题： 日志管理