调用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暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Engine | string | 是 | 数据库引擎,取值:
| MySQL |
StartTime | string | 是 | 任务开始时间,格式为 Unix 时间戳,单位为毫秒。 | 1655416825000 |
EndTime | string | 是 | 任务结束时间,格式为 Unix 时间戳,单位为毫秒。 说明
任务结束时间需晚于任务开始时间。
| 1655427625000 |
PageNo | string | 是 | 页码,取值大于 0 且不超过 Integer 数据类型的最大值,默认值为 1。 | 1 |
PageSize | string | 是 | 每页最大记录数,默认值为 10。 | 10 |
InstanceArea | string | 是 | 实例所属的数据库产品,取值:
说明
IDC 为用户数据中心。
| RDS |
SearchMap | string | 否 | 过滤条件,可以按照如下条件进行过滤:
| {"InstanceId":"rm-bp10usoc1erj7****"} |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-aek2eil6npi**** |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "200",
"Data": {
"List": [
{
"AutoFunction": {
"AutoIndex": 2,
"AutoLimitedSql": 2,
"AutoResourceOptimize": 0,
"AutoScale": 0,
"EventSubscription": 0
},
"Data": {
"test": "test",
"test2": 1
},
"EnableDasPro": 0,
"EndTime": 1608888296001,
"GmtCreate": 1603247192000,
"Instance": {
"AccountId": "108398049688****",
"Category": "standard",
"Cpu": "8",
"Engine": "MySQL",
"EngineVersion": "8.0",
"InstanceAlias": "test-01",
"InstanceArea": "RDS",
"InstanceClass": "rds.mysql.s2.xlarge",
"InstanceId": "rm-bp10usoc1erj7****",
"Memory": 32768,
"NetworkType": "VPC",
"NodeId": "rm-bp10usoc1erj7****",
"Region": "cn-hangzhou",
"Storage": 150,
"Uuid": "hdm_3063db6792965c080a4bcb6e6304****",
"VpcId": "vpc-bp1knt7m55z9exoo7****"
},
"Score": 100,
"ScoreMap": {
"test": "test",
"test2": 1
},
"StartTime": 1608888296000,
"State": 2,
"TaskType": 0
}
],
"PageNo": 1,
"PageSize": 10,
"Total": 4
},
"Message": "Successful",
"RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
"Success": "true"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 请求参数错误 |
403 | NoPermission | You are not authorized to do this action. | 没有权限执行该操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-11-07 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-10-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |