Querying Diagnosis Report Details
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}
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
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. |
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. |
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. |
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 ] } ] } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion; import com.huaweicloud.sdk.kafka.v2.*; import com.huaweicloud.sdk.kafka.v2.model.*; public class ShowMessageDiagnosisReportSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); KafkaClient client = KafkaClient.newBuilder() .withCredential(auth) .withRegion(KafkaRegion.valueOf("<YOUR REGION>")) .build(); ShowMessageDiagnosisReportRequest request = new ShowMessageDiagnosisReportRequest(); request.withInstanceId("{instance_id}"); request.withReportId("{report_id}"); try { ShowMessageDiagnosisReportResponse response = client.showMessageDiagnosisReport(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkafka.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = KafkaClient.new_builder() \ .with_credentials(credentials) \ .with_region(KafkaRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowMessageDiagnosisReportRequest() request.instance_id = "{instance_id}" request.report_id = "{report_id}" response = client.show_message_diagnosis_report(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := kafka.NewKafkaClient( kafka.KafkaClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowMessageDiagnosisReportRequest{} request.InstanceId = "{instance_id}" request.ReportId = "{report_id}" response, err := client.ShowMessageDiagnosisReport(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Successful |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot