Querying the Message Stack Diagnosis Report List

Updated on 2025-03-07 GMT+08:00

View PDF

Function

This API is used to query the message stack diagnosis report list.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/kafka/instances/{instance_id}/message-diagnosis-tasks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset. The records after this offset will be queried.
limit	No	Integer	Maximum number of records that can be returned.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
report_list	Array of KafkaMessageDiagnosisReportInfoEntity objects	Diagnosis reports.
total_num	Integer	Total number of diagnosis reports.

**Table 4** KafkaMessageDiagnosisReportInfoEntity
Parameter	Type	Description
report_id	String	Diagnosis report ID.
status	String	Status of a message stack diagnosis task. diagnosing failed deleted (manually) finished normal: No problems found. abnormal: Problems found.
begin_time	String	Diagnosis task start time.
end_time	String	Diagnosis task end time.
group_name	String	Name of the consumer group being diagnosed.
topic_name	String	Name of the topic being diagnosed.
accumulated_partitions	Integer	Number of partitions where accumulated messages are found.

Example Requests

Querying message stack diagnosis reports

GET https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/message-diagnosis-tasks?offset=1&limit=10

Example Responses

Status code: 200

Successful

{
  "report_list" : [ {
    "report_id" : "89b202d5-1f34-4a89-af9d-698496d0b7b1",
    "status" : "diagnosing",
    "begin_time" : "2022-11-11T10:00:00.000Z",
    "end_time" : "2022-11-11T10:00:00.000Z",
    "group_name" : "group-test",
    "topic_name" : "topic-test",
    "accumulated_partitions" : 3
  } ],
  "total_num" : 1
}