GetFullRequestStatResultByInstanceId - 按照SQL ID非同步統計全量請求資料 -

調用GetFullRequestStatResultByInstanceId介面，按照SQL ID非同步統計資料庫執行個體SQL洞察結果中的全量請求資料。

介面說明

說明

非同步呼叫後不會立即返回完整結果，當返回資料中 isFinish 取值為 false 時，請等待 1s 後重新發起調用，直到 isFinish 取值為 true 時，返回完整結果。

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 後，在調用 API 介面時，系統會自動擷取使用者識別碼。	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	integer	是	查詢開始時間，格式為 Unix 時間戳記，單位為毫秒。說明查詢開始時間需要在資料庫執行個體 SQL 洞察儲存時間長度範圍內，最大不能早於目前時間 90 天。	1645581813000
End	integer	是	查詢結束時間，格式為 Unix 時間戳記，單位為毫秒。說明查詢結束時間需晚於查詢開始時間，且查詢開始時間和查詢結束時間的間隔不能超過 1 天。	1645668213000
OrderBy	string	否	排序欄位，預設為 count。 count：執行次數。 avgRt：平均執行時間。 rtRate：耗時比例。 rowsExamined：總掃描行數。 avgRowsExamined：平均掃描行數。 avgRowsReturned：平均返回行數。	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：計算節點。 polarx_dn：資料節點。	polarx_cn

返回參數

名稱	類型	描述	樣本值
	object	返回資訊的詳細列表。
Message	string	請求返回訊息。說明請求成功時該參數返回 Successful，請求失敗時會返回請求異常資訊（如錯誤碼等）。	Successful
RequestId	string	請求 ID。	7172BECE-588A-5961-8126-C216E16B****
Data	object	返回資料。
Result	object	返回的全量請求資料。
List	array<object>	全量請求資料列表。
	object	全量請求資料列表。
SqlId	string	SQL ID。	d71f82be1eef72bd105128204d2e****
AvgFetchRows	integer	PolarDB-X 2.0 資料庫執行個體計算節點平均拉取資料節點的行數。	0
AvgLockWaitTime	number	平均鎖等待時間長度，單位為秒。	0.00009589874265269765
AvgLogicalRead	number	平均邏輯讀。	654.4470327860251
AvgPhysicalAsyncRead	integer	平均物理非同步讀取。	0
AvgPhysicalSyncRead	integer	平均物理同步讀取。	0
AvgExaminedRows	number	平均掃描行數。說明目前支援該欄位的資料庫：RDS MySQL、RDS PostgreSQL、PolarDB MySQL 版。	10000
AvgReturnedRows	number	平均返回行數。	10000
AvgUpdatedRows	integer	平均修改行數。說明目前支援該欄位的資料庫：RDS MySQL、PolarDB-X 2.0。	10000
AvgRt	number	平均執行耗時。	2.499
AvgSqlCount	integer	平均 SQL 計數。	10000
Count	integer	總執行次數。	100000
CountRate	number	執行次數比例。	0.0586
Database	string	資料庫名。	dbtest01
ErrorCount	integer	執行錯誤次數。	1
FetchRows	integer	PolarDB-X 2.0 資料庫執行個體計算節點拉取資料節點的行數。	0
Ip	string	執行個體的網路地址。	rm-uf6dyi58dm6**.mysql.rds.aliy**.com
LockWaitTime	number	鎖等待時間長度，單位為秒。	1089.4177720290281
LogicalRead	integer	邏輯讀。	7.434573266E9
PhysicalAsyncRead	integer	物理非同步讀取。	0
PhysicalSyncRead	integer	物理同步讀取。	0
Port	integer	連接埠號碼。	3306
Psql	string	SQL 模板。	select * from dbtest01 where ****
Rows	integer	PolarDB-X 2.0 資料庫執行個體計算節點總更新或返回的行數。	0
ExaminedRows	integer	總掃描行數。說明目前支援該欄位的資料庫：RDS MySQL、RDS PostgreSQL、PolarDB MySQL 版。	10000
RtGreaterThanOneSecondCount	integer	執行時間長度大於 1 秒的 SQL 數量。	20
RtRate	number	耗時比例。	2.499
SqlCount	integer	SQL 的數量。	200
SumUpdatedRows	integer	總變更行數。	100
Tables	array	資料庫表名。
	string	資料庫表名。	tabletest01,tabletest02
Version	integer	版本。	1
VpcId	string	VPC ID。	vpc-2zentqj1sk4qmolci****
Total	integer	總資料量。	1
Fail	boolean	請求是否失敗。 true：是。 false：否。	false
IsFinish	boolean	非同步請求是否執行完成。 true：是。 false：否。	true
ResultId	string	請求的 ID。	9CB97BC4-6479-55D0-B9D0-EA925AFE****
State	string	非同步請求的執行狀態。 RUNNING：正在運行。 SUCCESS：成功。 FAIL：失敗。	SUCCESS
Timestamp	integer	執行時間，格式為 Unix 時間戳記，單位為毫秒。	1645668213000
Code	integer	返回的狀態代碼。	200
Success	boolean	請求是否執行成功： true：執行成功。 false：執行失敗。	true

樣本

正常返回樣本

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.

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

變更歷史

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