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
|
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
|
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 |
|
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. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
operate_id |
String |
Operation ID. |
Status code: 400
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot