Obtaining Ad Hoc Query Results

Function

This API is used to obtain an ad hoc query result.

Calling Method

For details, see Calling APIs.

URI

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

**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.
query_id	Yes	String	Query ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
batch	Yes	Integer	Batch index.

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
batch	AnyType	Batch of data to be obtained. If the value is 0, the first query is performed.
schema	Array of AdhocQueryAnalysisField objects	Field type of statistical analysis result.
datarows	Array<Array<>>	Statistical analysis result data.
datarows_upsert	Array<Array<DataRow>>	Statistical analysis result data.
total	Integer	Total number of statistical analysis results.
size	Integer	Number of returned statistical analysis results.
next	Integer	Whether there is a next batch of data.
tips	tips object	Related information.
job_id	String	UUID

**Table 5** AdhocQueryAnalysisField
Parameter	Type	Description
name	String	Field name.
logical_type	Object	Field type.
alias	String	Field alias.

**Table 6** DataRow
Parameter	Type	Description
kind	String	Data type.
fields	Array of objects	Data row.

**Table 7** tips
Parameter	Type	Description
error_code	String	Error code.
error_key	String	Error key.
module_name	String	Module name.

Status code: 400

**Table 8** 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	Successful.
400	Error response.

Error Codes

See Error Codes.

Parent topic: Security Analysis

Previous topic: Creating an Ad Hoc Query

Next topic: Disabling the Query Operation

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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.

Chatbot