Files

chenjunjie 719d8b18de RocketMQ API 20250723 version

Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>

2026-03-18 20:25:09 +00:00

7.2 KiB

Raw Blame History

Creating an Instance Diagnosis Task

Function

This API is used to create an instance diagnosis task.

URI

POST /v2/{project_id}/rocketmq/instances/{instance_id}/diagnosis

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain it, 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 the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
group_name	Yes	String	Definition Consumer group name. Constraints N/A Range N/A Default Value N/A
node_id_list	No	Array of strings	Definition Node ID list. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
report_id	String	Definition Report ID. Constraints N/A Range N/A Default Value N/A

Example Requests

Creating an instance diagnosis task

POST https://{endpoint}/v2/{project_id}/rocketmq/instances/{instance_id}/diagnosis

{
  "group_name" : "test",
  "node_id_list" : [ ]
}

Example Responses

Status code: 200

success

{
  "report_id" : "b00a070e-75e0-4463-b53e-fbc29dcff951"
}

Status Codes

Status Code	Description
200	success

Error Codes

See Error Codes.

Parent topic: Instance Diagnosis

7.2 KiB Raw Blame History