Querying a Log Task

Function

This API is used to query 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

GET /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

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
log_response_list	Array of ShowKafkaLogTaskEntity objects	Definition Log response list.

**Table 3** ShowKafkaLogTaskEntity
Parameter	Type	Description
id	String	Definition Log record ID. Range N/A
instance_id	String	Definition Instance ID You can call the API for querying all instances to obtain it. The instance ID is in the response body. Range N/A
log_group_id	String	Definition Log group ID. Range N/A
log_stream_id	String	Definition Log stream ID. Range N/A
dashboard_id	String	Definition Dashboard ID. Range N/A
status	String	Definition Status. Range OPEN CLOSE CLOSING OPENING
log_type	String	Definition Status. Range REBALANCE: rebalancing logs topic_log: topic logs
log_file_name	String	Definition Log file name. Range N/A
created_at	Long	Definition Creation time. Range N/A
updated_at	Long	Definition Update time. Range N/A

Example Requests

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

Example Responses

Status code: 200

Log task queried.

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