文档首页> 云数据库 RDS> API参考> API v3(推荐)> 实例诊断> 获取指定诊断项的诊断结果
更新时间:2024-03-28 GMT+08:00

获取指定诊断项的诊断结果

功能介绍

获取指定诊断项的诊断结果。

URI

  • URI格式

    GET /v3/{project_id}/instances/diagnosis/info

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    租户在某一Region下的项目ID。

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

    表2 请求参数

    参数

    是否必选

    参数类型

    描述

    engine

    String

    引擎类型。

    枚举值:

    • mysql
    • postgresql
    • sqlserver

    diagnosis

    String

    诊断项。

    枚举值:

    • high_pressure
    • lock_wait
    • insufficient_capacity
    • slow_sql_frequency
    • disk_performance_cap
    • mem_overrun
    • age_exceed
    • connections_exceed

    offset

    Integer

    索引位置,偏移量。

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

    limit

    Integer

    返回结果的条数。缺省值:10

请求消息

  • 请求参数

    无。

  • URI样例

    GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/diagnosis/info?engine=sqlserver&diagnosis=high_pressure&offset=1&limit=10

响应消息

  • 正常响应要素说明
    表3 字段说明

    名称

    参数类型

    说明

    diagnosis

    String

    诊断项。

    枚举值:

    • high_pressure
    • lock_wait
    • insufficient_capacity
    • slow_sql_frequency
    • disk_performance_cap
    • mem_overrun
    • age_exceed
    • connections_exceed

    total_count

    Integer

    实例数量。

    instances

    Array of objects

    实例ID。

    请参见表4

    表4 instances字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    实例ID。

  • 正常响应样例
    { 
      "diagnosis" : "high_pressure", 
      "total_count" : 1, 
      "instances" : [ { 
        "id" : "abd21a25fdedfd6db69721f4b761bc38in04" 
      } ] 
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码