文档首页/ 云数据库 TaurusDB/ API参考/ API(推荐)/ 智能诊断/ 获取某个指标的异常实例信息
更新时间:2023-11-06 GMT+08:00

获取某个指标的异常实例信息

功能介绍

获取某个指标的异常实例信息。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

metric_name

String

指标名。

offset

Integer

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

limit

Integer

查询记录数。默认为100,不能为负数,最小值为1,最大值为100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。 取值范围:

  • en-us
  • zh-cn

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

当前指标的异常实例总数。

instance_infos

Array of InstanceInfoForDiagnosis objects

异常实例信息。

表5 InstanceInfoForDiagnosis

参数

参数类型

描述

instance_id

String

实例ID。

master_node_id

String

主节点ID。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

通过project_id以及指标名, 获取指标的异常实例信息, 并分页展示。

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/diagnosis-instance-infos?metric_name=high_pressure&offset=0&limit=10

响应示例

状态码: 200

Success.

{
  "total_count" : 6,
  "instance_infos" : [ {
    "instance_id" : "6206d5be05914703938ff9dfe5c07d34in07",
    "master_node_id" : "7fe925aa8bab4cc9bac3990a94386c29no07"
  }, {
    "instance_id" : "cbdb32e08f0440158c4f2998dbf69b14in07",
    "master_node_id" : "3e90e7b99b964dca9704b3af903fcb41no07"
  }, {
    "instance_id" : "325af119c2ca4e77b1deb4810a9b921bin07",
    "master_node_id" : "f4dfb362039a45818e59416abc9a5ca6no07"
  }, {
    "instance_id" : "9e8b52a5b6e84f4a9e4db01235b1c770in07",
    "master_node_id" : "408666cd6f104133ad0685b722f88cffno07"
  }, {
    "instance_id" : "5814254f12f74d16bd0a93885b00867fin07",
    "master_node_id" : "637d96ffbf6745ff835445fe87d08fc5no07"
  }, {
    "instance_id" : "d0da4882ebdf44bd9d3f1edf9b0bd4a2in07",
    "master_node_id" : "7a670f4ecdf14db5a4b5df737b0911a5no07"
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码