调用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代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetInstanceInspections

系统规定参数。取值：GetInstanceInspections。

Engine String 是 MySQL

数据库引擎，取值：

  • MySQL
  • Redis
  • PolarDBMySQL
StartTime String 是 1655416825000

任务开始时间，格式为Unix时间戳，单位为毫秒。
EndTime String 是 1655427625000

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

说明 任务结束时间需晚于任务开始时间。
PageNo String 是 1

页码，取值大于0且不超过Integer数据类型的最大值，默认值为1。
PageSize String 是 10

每页最大记录数，默认值为10。
InstanceArea String 是 RDS

实例所属的数据库产品，取值：

  • RDS：云实例。
  • ECS：ECS自建实例。
  • IDC：非公有云自建实例。
说明 IDC为用户数据中心。
SearchMap String 否 {"InstanceId":"rm-bp10usoc1erj7****"}

过滤条件，可以按照如下条件进行过滤：

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

返回数据

名称 类型 示例值 描述
Message String Successful

请求返回消息。

说明 请求成功时该参数返回Successful，请求失败时会返回请求异常信息（如错误码等）。
RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

请求ID。
Data Object

详细信息。
List Array of BaseInspection

详细信息列表。
EndTime Long 1608888296001

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

说明 任务结束时间需晚于任务开始时间。
StartTime Long 1608888296000

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

返回的数据。
Instance Object

实例信息。
VpcId String vpc-bp1knt7m55z9exoo7****

实例的VPC ID。
Uuid String hdm_3063db6792965c080a4bcb6e6304****

实例的唯一标识符号。
InstanceArea String RDS

实例所属的数据库产品，取值：

  • RDS：云实例。
  • ECS：ECS自建实例。
  • IDC：非公有云自建实例。
    说明 IDC为用户数据中心。
InstanceClass String rds.mysql.s2.xlarge

实例的规格。
Region String cn-hangzhou

实例所属的地域ID。
AccountId String 108398049688****

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

NetworkType String VPC

实例的网络类型。
Engine String MySQL

数据库引擎，取值：

  • MySQL
  • Redis
  • PolarDBMySQL
InstanceId String rm-bp10usoc1erj7****

实例ID。
NodeId String rm-bp10usoc1erj7****

实例的节点ID。
EngineVersion String 5.7

数据库引擎的版本号。
ScoreMap Map

扣分详情。
GmtCreate Long 1603247192000

任务的创建时间，格式为Unix时间戳，单位为毫秒。
Score Integer 100

巡检得分。
PageNo Long 1

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

每页最大记录数，默认值为10。
Total Long 4

总记录数。
Code String 200

返回的状态码。
Success String true

请求是否执行成功：

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

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=GetInstanceInspections
&Engine=MySQL
&StartTime=1655416825000
&EndTime=1655427625000
&PageNo=1
&PageSize=10
&InstanceArea=RDS
&SearchMap={"InstanceId":"rm-bp10usoc1erj7****"}
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<GetInstanceInspectionsResponse>
    <Message>Successful</Message>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Data>
        <List>
            <EndTime>1608888296001</EndTime>
            <StartTime>1608888296000</StartTime>
            <Instance>
                <VpcId>vpc-bp1knt7m55z9exoo7****</VpcId>
                <Uuid>hdm_3063db6792965c080a4bcb6e6304****</Uuid>
                <InstanceArea>RDS</InstanceArea>
                <InstanceClass>rds.mysql.s2.xlarge</InstanceClass>
                <Region>cn-hangzhou</Region>
                <AccountId>108398049688****</AccountId>
                <NetworkType>VPC</NetworkType>
                <Engine>MySQL</Engine>
                <InstanceId>rm-bp10usoc1erj7****</InstanceId>
                <NodeId>rm-bp10usoc1erj7****</NodeId>
                <EngineVersion>5.7</EngineVersion>
            </Instance>
            <GmtCreate>1603247192000</GmtCreate>
            <Score>100</Score>
        </List>
        <PageNo>1</PageNo>
        <PageSize>10</PageSize>
        <Total>4</Total>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</GetInstanceInspectionsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "Successful",
  "RequestId" : "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data" : {
    "List" : {
      "EndTime" : 1608888296001,
      "StartTime" : 1608888296000,
      "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" : 5.7
      },
      "GmtCreate" : 1603247192000,
      "Score" : 100
    },
    "PageNo" : 1,
    "PageSize" : 10,
    "Total" : 4
  },
  "Code" : 200,
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The request parameters are invalid. 请求参数错误

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