調(diào)用GetInstanceInspections接口,獲取數(shù)據(jù)庫實(shí)例巡檢評分的結(jié)果。
接口說明
DAS 支持巡檢評分功能,可以對目標(biāo)實(shí)例進(jìn)行定期巡檢并給出健康評分,幫助您清楚地了解數(shù)據(jù)庫運(yùn)行情況,更多信息,請參見巡檢評分。
使用該接口需滿足以下前提條件:
- 本接口只適用于 RDS MySQL、ECS 上的 MySQL 自建庫、IDC MySQL 自建庫、云數(shù)據(jù)庫 Tair(兼容 Redis)、PolarDB MySQL 版。
- 在使用阿里云 SDK 時(shí),需要保證 aliyun-sdk-core 的版本大于 4.3.3,建議使用最新版本。
- 使用 DAS 的 SDK 的版本為 1.0.3 或以上。
- 在使用 SDK 調(diào)用 DAS 服務(wù)時(shí),需要將地域指定為 cn-shanghai。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個(gè)操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
hdm:GetInstanceInspections | get | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Engine | string | 是 | 數(shù)據(jù)庫引擎,取值:
| MySQL |
StartTime | string | 是 | 任務(wù)開始時(shí)間,格式為 Unix 時(shí)間戳,單位為毫秒。 | 1655416825000 |
EndTime | string | 是 | 任務(wù)結(jié)束時(shí)間,格式為 Unix 時(shí)間戳,單位為毫秒。 說明
任務(wù)結(jié)束時(shí)間需晚于任務(wù)開始時(shí)間。
| 1655427625000 |
PageNo | string | 是 | 頁碼,取值大于 0 且不超過 Integer 數(shù)據(jù)類型的最大值,默認(rèn)值為 1。 | 1 |
PageSize | string | 是 | 每頁最大記錄數(shù),默認(rèn)值為 10。 | 10 |
InstanceArea | string | 是 | 實(shí)例所屬的數(shù)據(jù)庫產(chǎn)品,取值:
說明
IDC 為用戶數(shù)據(jù)中心。
| RDS |
SearchMap | string | 否 | 過濾條件,可以按照如下條件進(jìn)行過濾:
| {"InstanceId":"rm-bp10usoc1erj7****"} |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-aek2eil6npi**** |
返回參數(shù)
示例
正常返回示例
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"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 請求參數(shù)錯(cuò)誤 |
403 | NoPermission | You are not authorized to do this action. | 沒有權(quán)限執(zhí)行該操作 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2022-11-07 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
2022-10-28 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |