Help Center/ Distributed Message Service for RocketMQ/ API Reference/ APIs V2 (Recommended)/ Instance Diagnosis/ Querying an Instance Diagnosis Report List
Updated on 2026-04-30 GMT+08:00
View PDF

Querying an Instance Diagnosis Report List

Function

This API is used to query an instance diagnosis report list.

URI

GET /v2/{engine}/{project_id}/instances/{instance_id}/diagnosis

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

engine

Yes

String

Definition

Engine.

Constraints

N/A

Range

  • rocketmq: RocketMQ message engine.

  • reliability: RocketMQ message engine alias.

Default Value

N/A

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
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Offset where the query starts.

Constraints

N/A

Range

≥ 0

Default Value

0

limit

No

Integer

Definition

Number of records to query.

Constraints

N/A

Range

1–50

Default Value

10

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

diagnosis_report_list

Array of DiagnosisReportResp objects

Definition

Diagnosis report list.

Constraints

N/A

Range

N/A

Default Value

N/A

total_num

Long

Definition

Number of reports.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 4 DiagnosisReportResp

Parameter

Type

Description

report_id

String

Definition

Report ID.

Constraints

N/A

Range

N/A

Default Value

N/A

group_name

String

Definition

Consumer group name.

Constraints

N/A

Range

N/A

Default Value

N/A

consumer_nums

Integer

Definition

Number of consumers.

Constraints

N/A

Range

N/A

Default Value

N/A

status

String

Definition

Status.

Constraints

N/A

Range

  • diagnosing

  • failed

  • deleted (manually)

  • finished

  • normal: No problems found.

  • abnormal: Problems found.

Default Value

N/A

created_at

String

Definition

Creation time.

Constraints

N/A

Range

N/A

Default Value

N/A

abnormal_item_sum

Integer

Definition

Number of abnormal items.

Constraints

N/A

Range

N/A

Default Value

N/A

faulted_node_sum

Integer

Definition

Number of abnormal nodes.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

Querying an instance diagnosis report list

GET https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/diagnosis

Example Responses

Status code: 200

Queried.

{
  "diagnosis_report_list" : {
    "report_id" : "b00a070e-75e0-4463-b53e-fbc29dcff951",
    "status" : "finished",
    "consumer_nums" : 1,
    "group_name" : "test",
    "created_at" : "2025-05-28 11:25:58.477",
    "abnormal_item_sum" : 0,
    "faulted_node_sum" : 0
  },
  "total_num" : 1
}

Status Codes

Status Code

Description

200

Queried.

Error Codes

See Error Codes.

Parent Topic: Instance Diagnosis