Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Log Management/ Enabling a Log Task
Updated on 2026-04-16 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling a Log Task

Function

This API is used to enable a log task.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID You can call the API for querying all instances to obtain it. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

log_type

Yes

String

Definition

Log task type.

Constraints

N/A

Range

  • REBALANCE: rebalancing logs

  • topic_log: topic logs

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

log_task_list

No

Array of StartKafkaLogTaskReqEntity objects

Definition

Log task list.
Table 3 StartKafkaLogTaskReqEntity

Parameter

Mandatory

Type

Description

log_file_name

No

String

Definition

Log file name.

Constraints

N/A

Range

N/A

Default Value

N/A

log_group_name

No

String

Definition

Log group name.

Constraints

N/A

Range

N/A

Default Value

N/A

log_stream_name

No

String

Definition

Log stream name.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

ID of enabling a log task.

Range

N/A

Example Requests

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"
  } ]
}

Example Responses

Status code: 200

Log task enabled.

{
  "job_id" : "ff8080828bdc0f64018bdcadfd8f00d7"
}

Status Codes

Status Code

Description

200

Log task enabled.

Error Codes

See Error Codes.

Parent Topic: Log Management