調用DescribeSqlLogRecords介面,查詢DAS企業版日誌明細。
介面說明
使用該介面需滿足以下前提條件:
使用阿里雲或 DAS 的 SDK 時,建議使用最新版本。
在使用 SDK 調用 DAS 服務時,需要將地區指定為 cn-shanghai。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
hdm:DescribeSqlLogRecords |
list |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
資料庫執行個體 ID。 |
pc-2ze8g2am97624**** |
| NodeId |
string |
否 |
節點 ID。
|
pi-uf6k5f6g3912i**** |
| Role |
string |
否 |
PolarDB-X 2.0 資料庫執行個體節點的角色。
|
polarx_cn |
| Filters |
array<object> |
否 |
篩選條件列表。 |
|
|
object |
否 |
篩選條件。 |
||
| Key |
string |
否 |
過濾參數。 說明
支援的過濾參數及其取值請參考請求參數補充說明。 |
keyWords |
| Value |
string |
否 |
過濾參數取值。 |
select |
| StartTime |
integer |
否 |
開始時間,格式為 Unix 時間戳記,單位為毫秒。 |
1596177993000 |
| EndTime |
integer |
否 |
結束時間,格式為 Unix 時間戳記,單位為毫秒。 |
1608888296000 |
| PageNo |
integer |
否 |
分頁查詢的頁碼,從 1 開始,預設為 1。 |
1 |
| PageSize |
integer |
否 |
每頁最大記錄數,最大支援 100,預設值為 10。 |
10 |
Key 支援的參數和取值:
KeyWords:關鍵字,多個關鍵字間使用空格隔開。
LogicalOperator:關鍵字間的邏輯操作,取值為 and 或 or。
AccountName:使用者名稱,可以傳遞多個的,用逗號分開,上限為 5。
dbName:資料庫名稱,可以傳遞多個的,用逗號分開,上限為 5。
HostAddress:用戶端 IP 位址,可以傳遞多個的,用逗號分開,上限為 5。
MaxConsume:最大耗時,單位 us。
MinConsume:最小耗時,單位 us。
MaxScanRows:最大掃描行。
MinScanRows:最小掃描行。
SqlType:SQL 類型,取值 select、update、insert 或 delete。
State:執行結果,取值 0(成功)或 1(失敗)。
ThreadId:線程 ID。
SortKey:排序列名稱,取值 ScanRows(掃描行數)、UpdateRows(更新行數)、Consume(耗時)、ExecuteTime(執行時間)、ReturnRows(返回行數)、LockTime(鎖等待時間)、Frows(PolarDB-X 2.0 計算節點的拉取行數)、Scnt(PolarDB-X 2.0 計算節點的 DN 請求數)、CpuTime(CPU 執行時間)、PhysicalRead(物理讀)。
SortMethod:排序方式,取值 DESC(降序)、ASC(升序)。預設為 DESC。
TraceId:PolarDB-X 2.0 執行個體的跟蹤 ID。
MinRows:最小更新行數。
MaxRows:最大更新行數。
MinScnt:PolarDB-X 2.0 計算節點(CN)的 DN 最小請求數。
MaxScnt:PolarDB-X 2.0 計算節點(CN)的 DN 最大請求數。
TrxId:事務 ID。
Fail:錯誤碼。
SqlId:SQL ID。
JobId:通過非同步任務 ID 進一步查詢返回結果。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
根節點或根目錄 |
||
| Code |
string |
返回的狀態代碼。 |
200 |
| Message |
string |
請求返回訊息。 說明
請求成功時該參數返回 Successful,請求失敗時會返回請求異常資訊(如錯誤碼等)。 |
Successful |
| RequestId |
string |
請求 ID。 |
F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE |
| Success |
string |
請求是否執行成功:
|
true |
| Data |
object |
返回資料。 |
|
| StartTime |
integer |
開始時間,格式為 Unix 時間戳記,單位為毫秒。 |
1596177993000 |
| EndTime |
integer |
結束時間,格式為 Unix 時間戳記,單位為毫秒。 |
1608888296000 |
| TotalRecords |
integer |
總記錄數。 |
1 |
| Items |
object |
列表資料 |
|
| SQLLogRecord |
array<object> |
SQL 日誌資料。 |
|
|
object |
SQL 日誌資料。 |
||
| Ext |
string |
擴充資訊欄位,備用參數。 |
None |
| ExecuteTime |
string |
執行時間,格式為 UTC 時間: |
2023-12-07T02:15:32Z |
| OriginTime |
integer |
執行時間戳記,格式為 Unix 時間,單位為毫秒。 |
1701886532000 |
| HostAddress |
string |
用戶端 IP 位址。 |
11.197.XX.XX |
| UpdateRows |
integer |
更新行數。 |
0 |
| LogicRead |
integer |
邏輯讀。 |
0 |
| SqlText |
string |
SQL 陳述式。 |
select resource_id as cluster_id, tpl_name \n\tfrom dbfree_alert_resource_tpl_ref\n\twhere user_id=? and type='cluster' group by resource_id, tpl_name |
| LockTime |
integer |
鎖等待時間,單位毫秒。 |
0 |
| ScanRows |
integer |
掃描行數。 |
0 |
| ThreadId |
integer |
線程 ID。 |
None |
| State |
string |
執行狀態。
|
0 |
| DBName |
string |
資料庫名稱。 |
testdb |
| SqlType |
string |
SQL 陳述式的類型。 |
select |
| AccountName |
string |
資料庫帳號。 |
testname |
| PhysicSyncRead |
integer |
物理同步讀。 |
0 |
| PhysicAsyncRead |
integer |
物理非同步讀。 |
0 |
| TrxId |
string |
事務 ID。 |
200000 |
| ReturnRows |
integer |
返回行數。 |
0 |
| Consume |
integer |
執行耗時(us)。 |
58 |
| Vip |
string |
查詢連結的 endpoint 解析地址。 |
100.115.XX.XX |
| NodeId |
string |
節點 ID。 |
pi-uf6k5f6g3912i**** |
| SqlId |
string |
SQL ID。 |
c67649d4a7fb62c4f8c7a447c52b5b17 |
| UseImciEngine |
string |
PolarDB MySQL 版執行個體是否使用列存索引。
|
true |
| ParallelQueueTime |
string |
PolarDB MySQL 版執行個體的並行度。 |
2 |
| ParallelDegree |
string |
PolarDB MySQL 版執行個體的並行排隊時間,單位為毫秒。 |
10 |
| Scnt |
integer |
PolarDB-X 2.0 計算節點(CN)的 DN 請求數。 |
10 |
| Rows |
integer |
PolarDB-X 2.0 資料庫執行個體計算節點總更新或返回的行數。 |
10 |
| Frows |
integer |
PolarDB-X 2.0 計算節點(CN)的拉取行數。 |
10 |
| TraceId |
string |
PolarDB-X 2.0 的跟蹤 ID,即 SQL 在資料節點的執行 ID。 |
14c93b7c7bf00000 |
| PhysicRead |
integer |
物理讀。 |
0 |
| CpuTime |
integer |
CPU 執行時間,單位為微秒。 |
100 |
| Writes |
integer |
RDS SQL Server 引擎的寫入數。 |
10 |
| Collection |
string |
預留參數。 |
None |
| TableName |
string |
SQL 日誌記錄中的表名 |
das |
| ConnectionId |
string |
SQL 日誌記錄的串連 ID |
ld-****** |
| Protocol |
string |
SQL 日誌記錄的協議類型 |
MySQL |
| Params |
string |
SQL 日誌記錄的參數 |
[1, "das"] |
| ClientIp |
string |
SQL 日誌記錄中的用戶端 IP SQL 日誌記錄中用戶端的 IP 位址 |
10.0.0.1xx |
| ClientPort |
integer |
用戶端連接埠號碼 |
3306 |
| RowKey |
string |
SQL 日誌記錄的行鍵 |
23 |
| AffectColumns |
string |
受影響的列 |
["col1"] |
| Finish |
string |
任務是否完成。
說明
當 Finish 返回為 0,並且包含 JobId 欄位時,說明當前請求為非同步請求,無法直接擷取返回結果,需要進一步根據 JobId 進行查詢。查詢時將 JobId 作為 Filters 的輸入值,例如: |
1 |
| JobId |
string |
非同步任務 ID。 |
MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465 |
樣本
正常返回樣本
JSON格式
{
"Code": "200",
"Message": "Successful",
"RequestId": "F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE",
"Success": "true",
"Data": {
"StartTime": 1596177993000,
"EndTime": 1608888296000,
"TotalRecords": 1,
"Items": {
"SQLLogRecord": [
{
"Ext": "None",
"ExecuteTime": "2023-12-07T02:15:32Z",
"OriginTime": 1701886532000,
"HostAddress": "11.197.XX.XX",
"UpdateRows": 0,
"LogicRead": 0,
"SqlText": "select resource_id as cluster_id, tpl_name \\n\\tfrom dbfree_alert_resource_tpl_ref\\n\\twhere user_id=? and type='cluster' group by resource_id, tpl_name",
"LockTime": 0,
"ScanRows": 0,
"ThreadId": 0,
"State": "0",
"DBName": "testdb",
"SqlType": "select",
"AccountName": "testname",
"PhysicSyncRead": 0,
"PhysicAsyncRead": 0,
"TrxId": "200000",
"ReturnRows": 0,
"Consume": 58,
"Vip": "100.115.XX.XX",
"NodeId": "pi-uf6k5f6g3912i****",
"SqlId": "c67649d4a7fb62c4f8c7a447c52b5b17",
"UseImciEngine": "true",
"ParallelQueueTime": "2",
"ParallelDegree": "10",
"Scnt": 10,
"Rows": 10,
"Frows": 10,
"TraceId": "14c93b7c7bf00000 ",
"PhysicRead": 0,
"CpuTime": 100,
"Writes": 10,
"Collection": "None",
"TableName": "das",
"ConnectionId": "ld-******",
"Protocol": "MySQL",
"Params": "[1, \"das\"]",
"ClientIp": "10.0.0.1xx",
"ClientPort": 3306,
"RowKey": "23",
"AffectColumns": "[\"col1\"]"
}
]
},
"Finish": "1",
"JobId": "MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465"
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | 請求參數錯誤 |
| 403 | NoPermission | You are not authorized to do this action. | 沒有許可權執行該操作 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。