数据库智能管家 DBbrain
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据库智能管家 DBbrain > API 文档 > 数据库智能管家 DBbrain API 2019-10-16 > 其他接口 > 获取健康得分

获取健康得分

最近更新时间：2024-03-12 19:50:57

我的收藏

本页目录：

1. 接口描述

接口请求域名： dbbrain.tencentcloudapi.com 。

根据实例ID获取指定时间段（30分钟）的健康得分，以及异常扣分项。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeHealthScore。
Version 是 String 公共参数，本接口取值：2019-10-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 需要获取健康得分的实例ID。
示例值：cdb-test123
Time 是 Timestamp ISO8601 获取健康得分的时间。
示例值：2019-01-01T00:00:00+08:00
Product 是 String 服务产品类型，支持值包括： "mysql" - 云数据库 MySQL， "cynosdb" - 云数据库 TDSQL-C for MySQL，默认为"mysql"。
示例值：mysql

3. 输出参数

参数名称 类型 描述
Data HealthScoreInfo 健康得分以及异常扣分项。
示例值：-
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取健康得分

通过实例ID获取健康得分，以及异常扣分项。

输入示例

https://dbbrain.tencentcloudapi.com/?Action=DescribeHealthScore
&InstanceId=test
&Time=2019-01-01T00:00:00+08:00
&Product=mysql
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "8b307450-6118-11eb-88ad-93c053da68c6",
        "Data": {
            "IssueTypes": [
                {
                    "TotalCount": 0,
                    "Events": [],
                    "IssueType": "AVAILABILITY"
                },
                {
                    "TotalCount": 0,
                    "Events": [],
                    "IssueType": "MAINTAINABILITY"
                },
                {
                    "TotalCount": 1,
                    "Events": [
                        {
                            "DiagType": "高并发/压力请求",
                            "ScoreLost": 6,
                            "StartTime": "2020-09-22T00:00:00+00:00",
                            "EndTime": "2020-09-22T00:00:00+00:00",
                            "EventId": 780019530,
                            "Outline": "监控指标 \"cpu_use_rate\" 告警，当前值 100",
                            "Severity": 1,
                            "Metric": "cpu_use_rate",
                            "Count": 1
                        }
                    ],
                    "IssueType": "PERFORMANCE"
                },
                {
                    "TotalCount": 3,
                    "Events": [
                        {
                            "DiagType": "复制",
                            "ScoreLost": 10,
                            "StartTime": "2020-09-22T00:00:00+00:00",
                            "EndTime": "2020-09-22T00:00:00+00:00",
                            "EventId": 780018741,
                            "Outline": "复制IO线程中断",
                            "Severity": 1,
                            "Metric": "slave_io_running",
                            "Count": 1
                        },
                        {
                            "DiagType": "复制",
                            "ScoreLost": 10,
                            "StartTime": "2020-09-22T00:00:00+00:00",
                            "EndTime": "2020-09-22T00:00:00+00:00",
                            "EventId": 779984938,
                            "Outline": "复制IO线程中断",
                            "Severity": 1,
                            "Metric": "slave_io_running",
                            "Count": 1
                        },
                        {
                            "DiagType": "复制",
                            "ScoreLost": 8,
                            "StartTime": "2020-09-22T00:00:00+00:00",
                            "EndTime": "2020-09-22T00:00:00+00:00",
                            "EventId": 780021648,
                            "Outline": "复制延迟",
                            "Severity": 2,
                            "Metric": "slave_io_running",
                            "Count": 1
                        }
                    ],
                    "IssueType": "RELIABILITY"
                }
            ],
            "EventsTotalCount": 4,
            "HealthLevel": "RISK"
        }
    }
}

示例2 请求健康得分

请求健康得分。

输入示例

POST / HTTP/1.1
Host: dbbrain.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHealthScore
<公共请求参数>

{
    "InstanceId": "cdb-8jawylhf",
    "Product": "mysql",
    "Time": "2020-09-22T00:00:00+00:00"
}

输出示例

{
    "Response": {
        "RequestId": "0736b315-a9be-4991-92e6-28eccf3d31e3",
        "Data": {
            "IssueTypes": [
                {
                    "TotalCount": 0,
                    "Events": [],
                    "IssueType": "AVAILABILITY"
                },
                {
                    "TotalCount": 0,
                    "Events": [],
                    "IssueType": "MAINTAINABILITY"
                },
                {
                    "TotalCount": 0,
                    "Events": [],
                    "IssueType": "PERFORMANCE"
                },
                {
                    "TotalCount": 0,
                    "Events": [],
                    "IssueType": "RELIABILITY"
                }
            ],
            "HealthScore": 100,
            "EventsTotalCount": 0,
            "HealthLevel": "HEALTH"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
RequestLimitExceeded 请求的次数超过了频率限制。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
中国站