調用GetFullRequestStatResultByInstanceId接口,按照SQL ID異步統計數據庫實例SQL洞察結果中的全量請求數據。
接口說明
SQL 洞察功能可對 SQL 進行健康情況診斷、性能問題排查,詳情請參見 SQL 洞察。
- 目前支持的數據庫實例請參見 DAS 企業版使用說明。
- 在使用 SDK 調用 DAS 服務時,需要將地域指定為 cn-shanghai。
- 2024 年 09 月 01 日起,由于 SQL 的模板化算法優化,調用本接口時,SqlId 字段的值將發生變更。詳情請參見【通知】SQL 模板化算法優化。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
hdm:GetFullRequestStatResultByInstanceId | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
UserId | string | 否 | 用戶 ID,即創建數據庫實例的阿里云主賬號 ID。 說明
非必填,輸入目標數據庫實例 ID 后,在調用 API 接口時,系統會自動獲取用戶 ID。
| 196278346919**** |
InstanceId | string | 是 | 實例 ID。 | rm-2ze8g2am97624**** |
NodeId | string | 否 | 節點 ID。 說明
對于 PolarDB MySQL 版實例,需要提供節點 ID。
| pi-bp12v7243x012**** |
SqlId | string | 否 | SQL ID。 說明
填寫 SQL ID 時,統計目標 SQL ID 的全量請求數據;為空時,統計整個數據庫實例的全量請求數據。
| d71f82be1eef72bd105128204d2e**** |
OriginHost | string | 否 | 執行 SQL 的客戶端 IP 地址。 說明
非必填,輸入目標客戶端 IP 地址后,統計目標客戶端 IP 地址的全量請求數據;為空時,統計整個數據庫實例的全量請求數據。
| 172.26.XX.XXX |
Keyword | string | 否 | 查詢關鍵詞。 | dbtest01 |
Start | long | 是 | 查詢開始時間,格式為 Unix 時間戳,單位為毫秒。 說明
查詢開始時間需要在數據庫實例 SQL 洞察存儲時長范圍內,最大不能早于當前時間 90 天。
| 1645581813000 |
End | long | 是 | 查詢結束時間,格式為 Unix 時間戳,單位為毫秒。 說明
查詢結束時間需晚于查詢開始時間,且查詢開始時間和查詢結束時間的間隔不能超過 1 天。
| 1645668213000 |
OrderBy | string | 否 | 排序字段,默認為 count。
| count |
Asc | boolean | 否 | 升序排序開關,默認關閉。 | 關閉 |
PageNo | integer | 是 | 分頁查詢的頁碼,從 1 開始,默認為 1。 | 1 |
PageSize | integer | 是 | 分頁查詢每頁數據量,默認為 20。 | 20 |
SqlType | string | 否 | SQL 語句的類型,取值包括:SELECT、INSERT、UPDATE、DELETE、LOGIN、LOGOUT、MERGE、ALTER、CREATEINDEX、DROPINDEX、CREATE、DROP、SET、DESC、REPLACE、CALL、BEGIN、DESCRIBE、ROLLBACK、FLUSH、USE、SHOW、START、COMMIT 和 RENAME。 說明
當數據庫實例為 RDS MySQL、PolarDB MySQL 版、PolarDB-X 2.0 時,可以通過 SQL 語句類型進行統計。
| SELECT |
DbName | string | 否 | 數據庫名。 | dbtest01 |
Role | string | 否 | PolarDB-X 2.0 數據庫實例節點信息。
| polarx_cn |
返回參數
示例
正常返回示例
JSON
格式
{
"Message": "Successful",
"RequestId": "7172BECE-588A-5961-8126-C216E16B****",
"Data": {
"Result": {
"List": [
{
"SqlId": "d71f82be1eef72bd105128204d2e****",
"AvgFetchRows": 0,
"AvgLockWaitTime": 0.00009589874265269765,
"AvgLogicalRead": 654.4470327860251,
"AvgPhysicalAsyncRead": 0,
"AvgPhysicalSyncRead": 0,
"AvgExaminedRows": 10000,
"AvgReturnedRows": 10000,
"AvgUpdatedRows": 10000,
"AvgRt": 2.499,
"AvgSqlCount": 10000,
"Count": 100000,
"CountRate": 0.0586,
"Database": "dbtest01",
"ErrorCount": 1,
"FetchRows": 0,
"Ip": "rm-uf6dyi58dm6****.mysql.rds.aliy****.com",
"LockWaitTime": 1089.4177720290281,
"LogicalRead": 7434573266,
"PhysicalAsyncRead": 0,
"PhysicalSyncRead": 0,
"Port": 3306,
"Psql": "select * from dbtest01 where ****",
"Rows": 0,
"ExaminedRows": 10000,
"RtGreaterThanOneSecondCount": 20,
"RtRate": 2.499,
"SqlCount": 200,
"SumUpdatedRows": 100,
"Tables": [
"tabletest01,tabletest02"
],
"Version": 1,
"VpcId": "vpc-2zentqj1sk4qmolci****"
}
],
"Total": 1
},
"Fail": false,
"IsFinish": true,
"ResultId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
"State": "SUCCESS",
"Timestamp": 1645668213000
},
"Code": 200,
"Success": true
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParams | The request parameters are invalid. | 請求參數錯誤 |
403 | NoPermission | You are not authorized to do this action. | 沒有權限執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|