Creating Ad Hoc SQL Parameter Rendering

This API is used create ad hoc SQL parameter rendering.

For details, see Calling APIs.

POST /v2/{project_id}/workspaces/{workspace_id}/siem/ad-hoc-queries/sql-render

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Workspace ID.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
query	No	String	Query statement.
script_params	No	Array of ScriptParam objects	Script parameters.
transform_query	No	String	Query statement.
session_id	No	String	Console session ID.
time_zone	No	String	Time zone.
inter_active_params	No	Array of InterActiveParams objects	Interaction parameter list.
from	No	Long	Start.
to	No	Long	End.

**Table 4** ScriptParam
Parameter	Mandatory	Type	Description
key	No	String	Key.
value	No	String	Value.

**Table 5** InterActiveParams
Parameter	Mandatory	Type	Description
key	No	String	Key.
value	No	String	Value.
operator	No	String	Query operation.

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
operate_id	String	Flink SQL gateway operation ID, which is used to query data.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

None

None

Status Code	Description
200	Successful.
400	Error response.

Parent topic: Security Analysis

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.