Creating a Security Analysis Query
Function
This API is used to create a security analysis query.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/workspaces/{workspace_id}/siem/tables/{table_id}/analysis
|
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_id |
Yes |
String |
Table 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 |
|---|---|---|---|
|
query |
Yes |
String |
Retrieval query criteria. For details about the syntax, see the help documentation. |
|
from |
No |
Integer |
Timestamp, in ms. |
|
to |
No |
Integer |
Timestamp, in ms. |
|
limit |
Yes |
Long |
Limit |
|
offset |
No |
Long |
Limit |
|
script_params |
No |
Array of SearchScriptParam objects |
Script parameters. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
schema |
Array of SearchQueryField objects |
Query result. |
|
datarows |
Array<Array<>> |
Query result row. |
|
total |
Integer |
Total count of results |
|
size |
Integer |
Returned count of results |
|
results |
Array of SearchQueryResult objects |
Results in JSON format |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
Field name |
|
type |
String |
Definition Data type.
Constraints N/A Range
Default Value N/A |
|
alias |
String |
Field alias |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. A security analysis query result is returned. |
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