Querying Diagnosis Report Details

Updated on 2025-03-07 GMT+08:00

Function

This API is used to query diagnosis report details.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/kafka/instances/{instance_id}/message-diagnosis/{report_id}

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.

report_id

Yes

String

Message stack diagnosis report ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

abnormal_item_num

Integer

Total number of exceptions found in the diagnosis.

failed_item_num

Integer

Total number of failed diagnosis items.

normal_item_num

Integer

Total number of normal diagnosis items.

diagnosis_dimension_list

Array of KafkaMessageDiagnosisDimensionEntity objects

Diagnosis items.

Table 3 KafkaMessageDiagnosisDimensionEntity

Parameter

Type

Description

name

String

Diagnosis dimension name.

abnormal_num

Integer

Total number of abnormal items in this diagnosis dimension.

failed_num

Integer

Total number of failed items in this diagnosis dimension.

diagnosis_item_list

Array of KafkaMessageDiagnosisItemEntity objects

Diagnosis dimensions.

Table 4 KafkaMessageDiagnosisItemEntity

Parameter

Type

Description

name

String

Diagnosis item name.

result

String

Diagnosis result.

cause_ids

Array of KafkaMessageDiagnosisConclusionEntity objects

Diagnosis exception causes.

advice_ids

Array of KafkaMessageDiagnosisConclusionEntity objects

Suggestions for diagnosis exceptions.

partitions

Array of integers

Partitions affected by the diagnosis exceptions.

failed_partitions

Array of integers

Partitions that failed to be diagnosed.

broker_ids

Array of integers

Brokers affected by the diagnosis exceptions.

Table 5 KafkaMessageDiagnosisConclusionEntity

Parameter

Type

Description

id

Integer

Diagnosis conclusion ID.

params

Map<String,String>

Diagnosis conclusion parameters.

Example Requests

Querying diagnosis report details

GET https://{endpoint}/v2/{project_id}/kafka/instances/{instance_id}/message-diagnosis/{report_id}

Example Responses

Status code: 200

Successful

{
  "abnormal_item_num" : 2,
  "failed_item_num" : 2,
  "normal_item_num" : 1,
  "diagnosis_dimension_list" : [ {
    "name" : "server",
    "abnormal_num" : 1,
    "failed_num" : 1,
    "diagnosis_item_list" : [ {
      "name" : "fetch_error",
      "result" : "abnormal",
      "cause_ids" : [ {
        "id" : 1,
        "params" : {
          "THRESHOLD" : "90",
          "ERROR_CODE" : "[1,2,3]"
        }
      } ],
      "advice_ids" : [ {
        "id" : 1,
        "params" : { }
      } ],
      "partitions" : [ 1, 2, 3 ],
      "failed_partitions" : [ 4, 5, 6 ],
      "broker_ids" : [ 1, 2, 3 ]
    } ]
  } ]
}

Status Codes

Status Code

Description

200

Successful

Error Codes

See Error Codes.

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback