文档

GetInstanceInspections - 获取数据库实例巡检评分结果

更新时间:

调用GetInstanceInspections接口,获取数据库实例巡检评分的结果。

接口说明

DAS 支持巡检评分功能,可以对目标实例进行定期巡检并给出健康评分,帮助您清楚地了解数据库运行情况,更多信息,请参见巡检评分

使用该接口需满足以下前提条件:

  • 本接口只适用于 RDS MySQL、ECS 上的 MySQL 自建库、IDC MySQL 自建库、云数据库 Redis、PolarDB MySQL 版。
  • 在使用阿里云 SDK 时,需要保证 aliyun-sdk-core 的版本大于 4.3.3,建议使用最新版本。
  • 使用 DAS 的 SDK 的版本为 1.0.3 或以上。
  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hdm:GetInstanceInspectionsList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Enginestring

数据库引擎,取值:

  • MySQL
  • Redis
  • PolarDBMySQL
MySQL
StartTimestring

任务开始时间,格式为 Unix 时间戳,单位为毫秒。

1655416825000
EndTimestring

任务结束时间,格式为 Unix 时间戳,单位为毫秒。

说明 任务结束时间需晚于任务开始时间。
1655427625000
PageNostring

页码,取值大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。

1
PageSizestring

每页最大记录数,默认值为 10。

10
InstanceAreastring

实例所属的数据库产品,取值:

  • RDS:云实例。
  • ECS:ECS 自建实例。
  • IDC:非公有云自建实例。
说明 IDC 为用户数据中心。
RDS
SearchMapstring

过滤条件,可以按照如下条件进行过滤:

  • 以单个实例 ID 为过滤条件时,输入格式为:{"InstanceId":"实例 ID"}。
  • 以多个实例 ID 为过滤条件时,输入格式为:{"InstanceIds":["实例 ID1","实例 ID2"]},其中实例 ID 间以英文逗号(,)分隔。
  • 以实例所在地域为过滤条件时,输入格式为:{"region":"实例所在地域"}。
{"InstanceId":"rm-bp10usoc1erj7****"}
ResourceGroupIdstring

资源组 ID。

rg-aek2eil6npi****

返回参数

名称类型描述示例值
object
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Dataobject

详细信息。

Listobject []

详细信息列表。

EndTimelong

任务结束时间,格式为 Unix 时间戳,单位为毫秒。

说明 任务结束时间需晚于任务开始时间。
1608888296001
StartTimelong

任务开始时间,格式为 Unix 时间戳,单位为毫秒。

1608888296000
Dataobject

返回的数据。

"data": { "hasDeadLock": false, "exceptionTableMap": {}, "bigTransactionCount": 0, "cpu": 4, "isRds": true, "rdsEnable": true, "enable": false, "activeSessions": [], "bigTransactionList": [], "bigSessionList": [ { "blockDuration": 0, "active": false, "Time": 0, "db": "" },
Instanceobject

实例信息。

VpcIdstring

实例的 VPC ID。

vpc-bp1knt7m55z9exoo7****
Uuidstring

实例的唯一标识符号。

hdm_3063db6792965c080a4bcb6e6304****
InstanceAreastring

实例所属的数据库产品,取值:

  • RDS:云实例。
  • ECS:ECS 自建实例。
  • IDC:非公有云自建实例。
说明 IDC 为用户数据中心。
RDS
InstanceClassstring

实例的规格。

rds.mysql.s2.xlarge
Regionstring

实例所属的地域 ID。

cn-hangzhou
AccountIdstring

账号 ID,您可在阿里云账号管理安全设置页面获取登录账号的 ID。

108398049688****
NetworkTypestring

实例的网络类型。

VPC
Enginestring

数据库引擎,取值:

  • MySQL
  • Redis
  • PolarDBMySQL
MySQL
InstanceIdstring

实例 ID。

rm-bp10usoc1erj7****
NodeIdstring

实例的节点 ID。

rm-bp10usoc1erj7****
EngineVersionstring

数据库引擎的版本号。

8.0
InstanceAliasstring

实例名称

test-01
Cpustring

CPU 规格,例如返回 8 时代表 CPU 规格为 8 核。

8
Memoryinteger

数据库内存,单位为 MB。

32768
Storageinteger

存储空间,单位为 GB。

150
Categorystring

实例的访问模式,取值:

  • standard:标准访问模式。
  • safe:数据库代理模式。
standard
ScoreMapobject

扣分详情。

GmtCreatelong

任务的创建时间,格式为 Unix 时间戳,单位为毫秒。

1603247192000
Scoreinteger

巡检得分。

100
AutoFunctionobject

自治功能开启情况。

EventSubscriptioninteger

事件订阅:

  • 0:关闭。
  • 1:开启。
  • 2:不支持。
0
AutoIndexinteger

自动索引创建和删除:

  • 0:关闭。
  • 1:开启。
  • 2:不支持。
2
AutoLimitedSqlinteger

自动限流:

  • 0:关闭。
  • 1:开启。
  • 2:不支持。
2
AutoResourceOptimizeinteger

空间碎片自动回收:

  • 0:关闭。
  • 1:开启。
  • 2:不支持。
0
AutoScaleinteger

自动弹性伸缩:

  • 0:关闭。
  • 1:开启。
  • 2:不支持。
0
EnableDasProinteger

DAS 企业版:

  • 0:关闭。
  • 1:开启。
  • 2:不支持。
0
Stateinteger

巡检任务状态:

  • 0:等待执行。
  • 1:正在执行。
  • 2:巡检完成。
2
TaskTypeinteger

巡检任务发起类型:

  • 0:自动。
  • 1:手动。
0
PageNolong

页码,取值大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。

1
PageSizelong

每页最大记录数,默认值为 10。

10
Totallong

总记录数。

4
Codestring

返回的状态码。

200
Successstring

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "List": [
      {
        "EndTime": 1608888296001,
        "StartTime": 1608888296000,
        "Data": {
          "test": "test",
          "test2": 1
        },
        "Instance": {
          "VpcId": "vpc-bp1knt7m55z9exoo7****",
          "Uuid": "hdm_3063db6792965c080a4bcb6e6304****",
          "InstanceArea": "RDS",
          "InstanceClass": "rds.mysql.s2.xlarge",
          "Region": "cn-hangzhou",
          "AccountId": "108398049688****",
          "NetworkType": "VPC",
          "Engine": "MySQL",
          "InstanceId": "rm-bp10usoc1erj7****",
          "NodeId": "rm-bp10usoc1erj7****",
          "EngineVersion": "8.0",
          "InstanceAlias": "test-01",
          "Cpu": "8",
          "Memory": 32768,
          "Storage": 150,
          "Category": "standard"
        },
        "ScoreMap": {
          "test": "test",
          "test2": 1
        },
        "GmtCreate": 1603247192000,
        "Score": 100,
        "AutoFunction": {
          "EventSubscription": 0,
          "AutoIndex": 2,
          "AutoLimitedSql": 2,
          "AutoResourceOptimize": 0,
          "AutoScale": 0
        },
        "EnableDasPro": 0,
        "State": 2,
        "TaskType": 0
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "Total": 4
  },
  "Code": "200",
  "Success": "true"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-11-07OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-10-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈