Adhoc sql参数渲染 - CreateSqlRender
功能介绍
Adhoc sql参数渲染
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/workspaces/{workspace_id}/siem/ad-hoc-queries/sql-render
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
query |
否 |
String |
查询语句 |
|
script_params |
否 |
Array of ScriptParam objects |
脚本参数 |
|
transform_query |
否 |
String |
查询语句 |
|
session_id |
否 |
String |
Console会话ID |
|
time_zone |
否 |
String |
时区 |
|
inter_active_params |
否 |
Array of InterActiveParams objects |
交互参数列表 |
|
from |
否 |
Long |
起始 |
|
to |
否 |
Long |
终止 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
operate_id |
String |
Flink SQL Gateway操作ID,用于后续查询数据 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
{
"from" : 0,
"inter_active_params" : [ {
"key" : "d0f10807-51b7-4d4c-847d-876d4fd7dc50",
"operator" : "494426cf-a02d-4f6f-93d4-f4c30164517f",
"value" : "04753b6e-c20b-4586-ad65-a9113eacdbf3"
}, {
"key" : "dc58e65a-e410-41f0-a84d-ca03437aa34b",
"operator" : "9d9d03fa-595f-4388-90ca-99941faa9972",
"value" : "e8c10bdf-48b6-4541-85ae-5a333700135c"
} ],
"query" : "384247bb-2114-4bca-a781-eb71abf65d35",
"script_params" : [ {
"key" : "5dbecad6-4c1a-48b7-a0df-1d211c793c55",
"value" : "36a16ba4-6c12-4e13-8be0-8793ab93c055"
}, {
"key" : "24a31a0f-0182-4f60-a04b-72a59da614b3",
"value" : "52b87a0b-64c3-4434-b894-b5132d0e6afc"
} ],
"session_id" : "3ddb28e7-5ffe-4089-8509-77f308bd1b5c",
"time_zone" : "ce4ea29b-3767-4e75-8945-2b83c1cc156a",
"to" : 0,
"transform_query" : "bfd4a5dc-6ab5-4e38-9714-ee018c141f06"
}
响应示例
状态码:200
成功
{
"operate_id" : "ae4f9fb0-efcb-41cf-9be3-e99c825d6e60"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
|
400 |
错误响应 |
错误码
请参见错误码。