Updated on 2025-12-18 GMT+08:00

Creating an Ad Hoc Query

Function

This API is used to create an ad hoc query.

Calling Method

For details, see Calling APIs.

URI

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

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.

Request Parameters

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

session_id

No

String

UUID

query

No

String

Query details.

query_type

No

String

Query type.

from

No

Long

Start point.

to

No

Long

End point.

script_params

No

Array of ScriptParam objects

Script parameters.

time_zone

No

String

Time zone.

sql_render_from

No

Long

Start point.

sql_render_to

No

Long

End point.

source_page

No

String

Source page.

Table 4 ScriptParam

Parameter

Mandatory

Type

Description

key

No

String

Key.

value

No

String

Value.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

operate_id

String

Operation ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response body for creating an ad hoc query.

400

Error response.

Error Codes

See Error Codes.