流式查询完整列存审计日志。
接口说明
调试
您可以在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": true,
"AccessDeniedDetail": {
"AuthAction": "polardbx:QueryColumnarLogSSE",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "示例 RAM 用户",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
},
"Records": [
{
"key": "null"
}
],
"AppliedOffset": 0,
"AppliedRowLimit": 1000,
"ReturnedRowCount": 100,
"HasMore": true,
"RecordsSizeBytes": 8192,
"QueryElapsedTimeMilliseconds": 125
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。