調用GetInstanceInspections API擷取資料庫執行個體巡檢評分結果-資料庫自治服務-阿里雲

調用GetInstanceInspections介面，擷取資料庫執行個體巡檢評分的結果。

介面說明

DAS 支援巡檢評分功能，可以對目標執行個體進行定期巡檢並給出健康評分，協助您清楚地瞭解資料庫運行情況，更多資訊，請參見巡檢評分。

使用該介面需滿足以下前提條件：

本介面只適用於 RDS MySQL、ECS 上的 MySQL 自建庫、IDC MySQL 自建庫、雲資料庫 Tair（相容 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:GetInstanceInspections

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Engine	string	是	資料庫引擎，取值： MySQL Redis PolarDB MySQL	MySQL
StartTime	string	是	任務開始時間，格式為 Unix 時間戳記，單位為毫秒。	1655416825000
EndTime	string	是	任務結束時間，格式為 Unix 時間戳記，單位為毫秒。說明任務結束時間需晚於任務開始時間。	1655427625000
PageNo	string	是	頁碼，取值大於 0 且不超過整數資料類型的最大值，預設值為 1。	1
PageSize	string	是	每頁最大記錄數，預設值為 10。	10
InstanceArea	string	是	執行個體所屬的資料庫產品，取值： RDS：雲執行個體。 ECS：ECS 自建執行個體。 IDC：非公用雲端自建執行個體。說明 IDC 為使用者資料中心。	RDS
SearchMap	string	否	過濾條件，可以按照如下條件進行過濾：以單個執行個體 ID 為過濾條件時，輸入格式為：{"InstanceId":"執行個體 ID"}。以多個執行個體 ID 為過濾條件時，輸入格式為：{"InstanceIds":["執行個體 ID1","執行個體 ID2"]}，其中執行個體 ID 間以英文逗號（,）分隔。以執行個體所在地區為過濾條件時，輸入格式為：{"region":"執行個體所在地區"}。	{"InstanceId":"rm-bp10usoc1erj7****"}
ResourceGroupId	string	否	資源群組 ID。	rg-aek2eil6npi****

返回參數

名稱	類型	描述	樣本值
	object
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
RequestId	string	請求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	詳細資料。
List	array<object>	詳細資料列表。
	array<object>
EndTime	integer	任務結束時間，格式為 Unix 時間戳記，單位為毫秒。說明任務結束時間需晚於任務開始時間。	1608888296001
StartTime	integer	任務開始時間，格式為 Unix 時間戳記，單位為毫秒。	1608888296000
Data	object	返回的資料。	"data": { "hasDeadLock": false, "exceptionTableMap": {}, "bigTransactionCount": 0, "cpu": 4, "isRds": true, "rdsEnable": true, "enable": false, "activeSessions": [], "bigTransactionList": [], "bigSessionList": [ { "blockDuration": 0, "active": false, "Time": 0, "db": "" },
Instance	object	執行個體資訊。
VpcId	string	執行個體的 VPC ID。	vpc-bp1knt7m55z9exoo7****
Uuid	string	執行個體的唯一識別碼號。	hdm_3063db6792965c080a4bcb6e6304****
InstanceArea	string	執行個體所屬的資料庫產品，取值： RDS：雲執行個體。 ECS：ECS 自建執行個體。 IDC：非公用雲端自建執行個體。說明 IDC 為使用者資料中心。	RDS
InstanceClass	string	執行個體的規格。	rds.mysql.s2.xlarge
Region	string	執行個體所屬的地區 ID。	cn-hangzhou
AccountId	string	帳號 ID，您可在阿里雲帳號管理的安全設定頁面擷取登入帳號的 ID。	108398049688****
NetworkType	string	執行個體的網路類型。	VPC
Engine	string	資料庫引擎，取值： MySQL Redis PolarDBMySQL	MySQL
InstanceId	string	執行個體 ID。	rm-bp10usoc1erj7****
NodeId	string	執行個體的節點 ID。	rm-bp10usoc1erj7****
EngineVersion	string	資料庫引擎的版本號碼。	8.0
InstanceAlias	string	執行個體名稱	test-01
Cpu	string	CPU 規格，例如返回 8 時代表 CPU 規格為 8 核。	8
Memory	integer	資料庫記憶體，單位為 MB。	32768
Storage	integer	儲存空間，單位為 GB。	150
Category	string	執行個體的訪問模式，取值： standard：標準訪問模式。 safe：資料庫代理模式。	standard
ScoreMap	object	扣分詳情。
GmtCreate	integer	任務的建立時間，格式為 Unix 時間戳記，單位為毫秒。	1603247192000
Score	integer	巡檢得分。	100
AutoFunction	object	自治功能開啟情況。
EventSubscription	integer	事件訂閱： 0：關閉。 1：開啟。 2：不支援。	0
AutoIndex	integer	自動索引建立和刪除： 0：關閉。 1：開啟。 2：不支援。	2
AutoLimitedSql	integer	自動限流： 0：關閉。 1：開啟。 2：不支援。	2
AutoResourceOptimize	integer	空間片段自動回收： 0：關閉。 1：開啟。 2：不支援。	0
AutoScale	integer	自動Auto Scaling： 0：關閉。 1：開啟。 2：不支援。	0
EnableDasPro	integer	DAS 企業版： 0：關閉。 1：開啟。 2：不支援。	0
State	integer	巡檢任務狀態： 0：等待執行。 1：正在執行。 2：巡檢完成。	2
TaskType	integer	巡檢任務發起類型： 0：自動。 1：手動。	0
PageNo	integer	頁碼，取值大於 0 且不超過整數資料類型的最大值，預設值為 1。	1
PageSize	integer	每頁最大記錄數，預設值為 10。	10
Total	integer	總記錄數。	4
Code	string	返回的狀態代碼。	200
Success	string	請求是否執行成功： 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	錯誤碼	錯誤資訊	描述
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。