串流查詢完整欄存稽核日誌。
介面說明
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST / HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
請求地域 ID，必須與目前 SQLQuery 服務部署地域一致。 |
cn-hangzhou |
| DBInstanceName |
string |
是 |
要查詢欄存稽核日誌的 PolarDB-X 執行個體 ID。 |
pxc-******** |
| SQL |
string |
是 |
要執行的唯讀查詢語句。僅支援單條 MySQL SELECT；查詢資料表必須使用 polardbx_sls.<表名> 全限定形式，並且僅限 polardbx_sls.polardbx_log（核心日誌）、polardbx_sls.slow_detail_log（慢速日誌）、polardbx_sls.slow_trans_log（慢速交易日誌）和 polardbx_sls.sql_audit_log（稽核日誌）。不支援多語句、寫入操作、鎖定、使用者變數、動態預留位置或保留 Hint。 |
SELECT * FROM polardbx_sls.sql_audit_log LIMIT 100 |
| MaxResultRows |
integer |
否 |
本次請求最多傳回的結果列數。取值範圍為 1～10000；未傳送時不會額外收緊呼叫方 SQL，仍受伺服器端 SSE 上限 10000 列和 SQL 頂層 LIMIT 約束。 |
1000 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Type |
string |
SSE 事件類型。RECORD 攜帶一批查詢結果；EOF 表示查詢完整結束；ERROR 表示查詢異常結束。 |
RECORD |
| RequestId |
string |
請求 ID。同一請求從接入、驗證、路由、查詢到所有 SSE 事件均使用該 ID，便於全鏈路排查。 |
C457B28E-9CAB-4B77-B5C6-5D71B7870B6E |
| QueryId |
string |
服務為本次 JDBC 查詢產生的唯一識別碼。同一 SSE 串流的所有事件使用相同的 QueryId。 |
5d3d88ea-3df0-4c2d-a8bb-2ec423b86b56 |
| Sequence |
integer |
RECORD 事件的順序號，從 1 開始遞增。該欄位表示事件順序，不表示結果列偏移量。 |
1 |
| Code |
string |
穩定錯誤碼，僅在 Type 為 ERROR 時傳回。呼叫方應根據該欄位處理錯誤，不要依賴 Message 文字。 |
InternalError |
| Message |
string |
錯誤摘要，僅在 Type 為 ERROR 時傳回。 |
查詢執行失敗 |
| Retryable |
boolean |
目前 ERROR 是否適合重試。true 表示可按錯誤傳回的建議重試；false 表示應先修改請求或由伺服器端排查。 |
true |
| Partial |
boolean |
發生 ERROR 前是否已經傳送過至少一個 RECORD 事件。true 表示呼叫方已收到的結果不完整，不應當作完整查詢結果使用。 |
|
| AccessDeniedDetail |
object |
無權限存取詳情。 |
|
| AuthAction |
string |
說明如上。 |
polardbx:QueryColumnarLogSSE |
| AuthPrincipalType |
string |
請求中用於驗證的身份類型。具體取值為：
|
222 |
| AuthPrincipalOwnerId |
string |
驗證主體 OwnerId。 |
111 |
| AuthPrincipalDisplayName |
string |
驗證主體名稱。 |
範例 RAM 用戶 |
| PolicyType |
string |
原則類型。 |
PRIORITY |
| NoPermissionType |
string |
無權限類型。 |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
編碼診斷資訊。 |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
| Records |
array<object> |
僅在 Type 為 RECORD 時傳回。本事件攜帶的一批查詢結果；每列是欄名到文字值的 JSON 鍵值物件，SQL NULL 固定編碼為字串 null。 |
|
|
object |
資料表欄位。 |
||
|
string |
查詢結果中的單個欄位值。所有純量均以字串傳回；SQL NULL 固定編碼為字串 null，空字串保持為空字串。 |
null |
|
| AppliedOffset |
integer |
僅在 Type 為 EOF 時傳回。服務實際套用的頂層 SQL LIMIT 偏移量；SQL 未指定偏移量時為 0。 |
0 |
| AppliedRowLimit |
integer |
僅在 Type 為 EOF 時傳回。服務綜合 SQL 頂層 LIMIT、MaxResultRows 和目前服務策略後實際套用的最大傳回列數，不包含用於偵測 HasMore 的額外一列。 |
1000 |
| ReturnedRowCount |
integer |
僅在 Type 為 EOF 時傳回。本次 SSE 串流實際傳回的結果總列數。 |
100 |
| HasMore |
boolean |
僅在 Type 為 EOF 時傳回。表示服務或 API 列數邊界是否截斷了呼叫方提交的 SQL；SQL 自身較小的 LIMIT 完整執行時為 false，不代表底層資料表中沒有更多資料。 |
False |
| RecordsSizeBytes |
integer |
僅在 Type 為 EOF 時傳回。所有已傳回列的 JSON 物件 UTF-8 位元組數之和，不包含陣列、SSE 幀和固定回應欄位。 |
8192 |
| QueryElapsedTimeMilliseconds |
integer |
僅在 Type 為 EOF 時傳回。從 JDBC 語句開始執行到讀取完最後一條傳回列或偵測列的耗時，單位為毫秒。 |
125 |
樣本
正常返回樣本
JSON格式
{
"Type": "RECORD",
"RequestId": "C457B28E-9CAB-4B77-B5C6-5D71B7870B6E",
"QueryId": "5d3d88ea-3df0-4c2d-a8bb-2ec423b86b56",
"Sequence": 1,
"Code": "InternalError",
"Message": "查詢執行失敗",
"Retryable": true,
"Partial": false,
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
},
"Records": [
{
"key": "null"
}
],
"AppliedOffset": 0,
"AppliedRowLimit": 1000,
"ReturnedRowCount": 100,
"HasMore": true,
"RecordsSizeBytes": 8192,
"QueryElapsedTimeMilliseconds": 125
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。