Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Diagnosis Management/ Pre-check Before Diagnosing Message Stack
Updated on 2026-03-16 GMT+08:00
View PDF

Pre-check Before Diagnosing Message Stack

Function

This API is used to pre-check before diagnosing message stack.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/kafka/instances/{instance_id}/diagnosis-check

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

Parameter

Mandatory

Type

Description

group

Yes

String

Consumer group name.

topic

Yes

String

Topic name.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of KafkaDiagnosisCheckEntity objects

Returned object of Kafka message stack diagnosis pre-check.
Table 4 KafkaDiagnosisCheckEntity

Parameter

Type

Description

name

String

Pre-check item name.

reason

String

Pre-check failure cause.

success

Boolean

Whether pre-check succeeded.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Pre-checking topic-1 subscribed by consumer group group-1 before diagnosing message stack

GET https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/diagnosis-check?group=group-1&topic=topic-1

Example Responses

Status code: 200

Successful

[ {
  "name" : "RAM",
  "success" : false,
  "reason" : "1,2"
}, {
  "name" : "CPU",
  "success" : false,
  "reason" : "1,2"
}, {
  "name" : "SUBSCRIPTION",
  "success" : false,
  "reason" : "0,2"
}, {
  "name" : "LAG",
  "success" : false,
  "reason" : "{\"0\":10159908,\"1\":9768464,\"2\":9361706}"
}, {
  "name" : "PRODUCE",
  "success" : false,
  "reason" : "{\"1694571420000\":14.159}"
} ]

Status Codes

Status Code

Description

200

Successful

400

Invalid parameter

Error Codes

See Error Codes.

Parent Topic: Diagnosis Management