Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Intelligent Diagnosis/ Querying Abnormal Instances by Each Metric
Updated on 2025-07-29 GMT+08:00

Querying Abnormal Instances by Each Metric

Function

This API is used to query abnormal instances by each metric. Before calling this API:

URI

GET /v3/{project_id}/instances/diagnosis-instance-count

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

diagnosis_info

Array of DiagnosisInfo objects

Definition

Diagnosis information list.

Table 4 DiagnosisInfo

Parameter

Type

Description

metric_name

String

Definition

Metric name.

Range

N/A

count

Integer

Definition

Number of instances.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the number of abnormal instances by each metric based on project_id.

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/diagnosis-instance-count

Example Response

Status code: 200

Success.

{
  "diagnosis_info" : [ {
    "metric_name" : "high_pressure",
    "count" : 8
  }, {
    "metric_name" : "insufficient_capacity",
    "count" : 0
  }, {
    "metric_name" : "slow_sql_frequency",
    "count" : 0
  }, {
    "metric_name" : "mem_overrun",
    "count" : 0
  }, {
    "metric_name" : "connections_exceed",
    "count" : 0
  } ]
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.