Creating a Message Stack Diagnosis Task

Function

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

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

Предыдущая статья

Pre-check Before Diagnosing Message Stack

Следующая статья

Querying the Message Stack Diagnosis Report List

Была ли эта статья полезна?

Поддержка Юридические документы