文档首页/ 数据管理服务 DAS/ API参考/ API（公测中）/ 云DBA/ 查询风险实例列表 - QueryRiskList
更新时间：2025-11-28 GMT+08:00
查看PDF
分享

查询风险实例列表 - QueryRiskList

功能介绍

查询风险实例列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    das::showCloudDBAInfo

    read

    instance

    -

    -

    -

URI

GET /v3/{project_id}/tenant-panel/query-risk-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。标识实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

from

是

Long

参数解释：

开始时间。

约束限制：

Unix timestamp，单位：毫秒。

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

to

是

Long

参数解释：

结束时间。

约束限制：

Unix timestamp，单位：毫秒。

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

engine_type

是

String

参数解释：

数据库类型。

约束限制：

不涉及

取值范围：

  • MySQL
  • TaurusDB
  • PostgreSQL
  • Microsoft SQL Server

默认取值：

不涉及。

num

否

Integer

参数解释：

返回TOP风险实例数量。

约束限制：

不涉及

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

metric_code

否

String

参数解释：

指标码。

约束限制：

不涉及

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

metric_code

String

参数解释：

指标名。

取值范围：

不涉及。

display_metric_codes

Array of strings

参数解释：

指标展示名称。

取值范围：

不涉及。

metric_names

Array of strings

参数解释：

指标名称。

取值范围：

不涉及。

units

Array of strings

参数解释：

单位。

取值范围：

不涉及。

items

Array of Items objects

参数解释：

风险实例列表。

取值范围：

不涉及。
表4 Items

参数

参数类型

描述

node_id

String

参数解释：

节点ID。

取值范围：

不涉及。

instance_info

Array of Instance objects

参数解释：

实例信息列表。

取值范围：

不涉及。

values

Array of double

参数解释：

指标值。

取值范围：

不涉及。
表5 Instance

参数

参数类型

描述

instance_id

String

参数解释：

实例ID。

取值范围：

不涉及。

instance_name

String

参数解释：

实例名称。

取值范围：

不涉及。

请求示例

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/tenant-panel/query-risk-list

响应示例

状态码： 200

Success.

{
    "metric_code": "sys001_cpu_usage",
    "display_metric_codes": [
        "CPU使用率",
        "活跃连接数",
        "慢SQL数"
    ],
    "metric_names": [
        "cpu_usage",
        "conn_active_count",
        "slow_queries"
    ],
    "units": [
        "%",
        "count",
        "count/min"
    ],
    "items": [
        {
            "instance_info": {
                "instance_id": "0d3f256d364949ddaed594a0f46c33bcin01",
                "instance_name": "replica-1f92"
            },
            "node_id": "d37dbcabae1d4668b8de1470309f49c0no01",
            "values": [
                99.29,
                1.0,
                0.0
            ]
        }
    ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 云DBA

相关文档