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

Querying an Instance Diagnosis Report

Function

This API is used to query an instance diagnosis report.

URI

GET /v2/{engine}/{project_id}/diagnosis/{report_id}

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, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

report_id

Yes

String

Definition:

Report ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

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

Long

Definition

Generation 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

online

Boolean

Definition

Online or not.

Range

  • True: online

  • False: not online

message_accumulation

Integer

Definition

Number of stacked messages.

Constraints

N/A

Range

N/A

Default Value

N/A

subscription_consistency

Boolean

Definition

Subscription consistency.

Constraints

N/A

Range

  • True: The subscription relationship is consistent.

  • False: The subscription relationship is inconsistent.

Default Value

N/A

duplicate_client_id

Boolean

Definition

Whether there are duplicate client IDs.

Constraints

N/A

Range

  • True: Yes

  • False: No

Default Value

N/A

different_consumer_type

Boolean

Definition

Whether there are inconsistent consumption types.

Constraints

N/A

Range

  • True: Yes

  • False: No

Default Value

N/A

subscriptions

Array of SubscriptionEntity objects

Definition

Subscriber list.

Constraints

N/A

Range

N/A

Default Value

N/A

diagnosis_node_report_list

Array of DiagnosisNodeReportEntity objects

Definition

Diagnosis node report list.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 SubscriptionEntity

Parameter

Type

Description

topic_name

String

Definition

Topic name.

Constraints

N/A

Range

N/A

Default Value

N/A

consumers_in_tags

Array of ConsumersInTagEntity objects

Definition

Consumer tag list.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 4 ConsumersInTagEntity

Parameter

Type

Description

consumers

Array of strings

Definition

Consumer list.

Constraints

N/A

Range

N/A

Default Value

N/A

tag_name

String

Definition

Tag name.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 5 DiagnosisNodeReportEntity

Parameter

Type

Description

node_id

String

Definition

Node ID.

Constraints

N/A

Range

N/A

Default Value

N/A

is_faulted

Boolean

Definition

Whether a node is faulty.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

abnormal_item_sum

Integer

Definition

Total number of exceptions.

Constraints

N/A

Range

N/A

Default Value

N/A

message_accumulation

Integer

Definition

Number of stacked messages.

Constraints

N/A

Range

N/A

Default Value

N/A

dead_lock

Boolean

Definition

Whether a deadlock occurs.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

deadlock_thread

String

Definition

Deadlock thread.

Constraints

N/A

Range

N/A

Default Value

N/A

stack_id

String

Definition

Thread ID.

Constraints

N/A

Range

N/A

Default Value

N/A

is_pop

Boolean

Definition

Whether pop consumption is used.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

consume_type

String

Definition

Consumption type.

Constraints

N/A

Range

  • CONSUME_POP: pop mode

  • CONSUME_PASSIVELY: push mode

  • CONSUME_ACTIVELY: pull mode

Default Value

N/A

Example Requests

Querying an instance diagnosis report

GET https://{endpoint}/v2/{engine}/{project_id}/diagnosis/{report_id}

Example Responses

Status code: 200

Queried.

{
  "report_id" : "3019dd35-361c-4631-a8d8-3578c0a7d102",
  "group_name" : "test",
  "consumer_nums" : 0,
  "status" : "finished",
  "created_at" : 1748402725731,
  "abnormal_item_sum" : 1,
  "faulted_node_sum" : 0,
  "online" : false,
  "message_accumulation" : 0,
  "subscription_consistency" : true,
  "duplicate_client_id" : false,
  "different_consumer_type" : false,
  "subscriptions" : [ ],
  "diagnosis_node_report_list" : [ ]
}

Status Codes

Status Code

Description

200

Queried.

Error Codes

See Error Codes.

Parent Topic: Instance Diagnosis