Creating a Message Stack Diagnosis Task

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

View PDF

Function

This API is used to create a message stack diagnosis task.

Calling Method

For details, see Calling APIs.

URI

POST /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.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
group_name	Yes	String	Consumer group name.
topic_name	Yes	String	Topic name.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
report_id	String	Diagnosis report ID.

Example Requests

Creating a message stack diagnosis task for consumer group group-test and topic topic-test

POST https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/message-diagnosis-tasks

{
  "group_name" : "group-test",
  "topic_name" : "topic-test"
}

Example Responses

Status code: 200

Message stack diagnosis task ID.

{
  "report_id" : "0e35a9f4-e75d-4fd6-b230-280860f666f7"
}

Status Codes

Status Code	Description
200	Message stack diagnosis task ID.

Error Codes

See Error Codes.

Parent Topic: Diagnosis Management

Previous topic: Pre-check Before Diagnosing Message Stack

Next topic: Querying the Message Stack Diagnosis Report List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel