Updated on 2026-02-05 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

{
  "session_id" : "AFBF91E7-6AF0-419C-8611-DB6F5D42057D",
  "query" : "SELECT * FROM s_afdasdf",
  "from" : 1768044252498,
  "to" : 1768045152498,
  "query_type" : "QUERY",
  "time_zone" : "Asia/Shanghai"
}

Example Responses

Status code: 200

Response body for creating an ad hoc query.

{
  "operate_id" : "208915df-7150-47d9-a6f9-4aa575efd142"
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;


public class CreateAdhocQuerySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAdhocQueryRequest request = new CreateAdhocQueryRequest();
        request.withWorkspaceId("{workspace_id}");
        CreateAdhocQueryRequestBody body = new CreateAdhocQueryRequestBody();
        body.withTimeZone("Asia/Shanghai");
        body.withTo(1768045152498L);
        body.withFrom(1768044252498L);
        body.withQueryType("QUERY");
        body.withQuery("SELECT * FROM s_afdasdf");
        body.withSessionId("AFBF91E7-6AF0-419C-8611-DB6F5D42057D");
        request.withBody(body);
        try {
            CreateAdhocQueryResponse response = client.createAdhocQuery(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateAdhocQueryRequest()
        request.workspace_id = "{workspace_id}"
        request.body = CreateAdhocQueryRequestBody(
            time_zone="Asia/Shanghai",
            to=1768045152498,
            _from=1768044252498,
            query_type="QUERY",
            query="SELECT * FROM s_afdasdf",
            session_id="AFBF91E7-6AF0-419C-8611-DB6F5D42057D"
        )
        response = client.create_adhoc_query(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateAdhocQueryRequest{}
	request.WorkspaceId = "{workspace_id}"
	timeZoneCreateAdhocQueryRequestBody:= "Asia/Shanghai"
	toCreateAdhocQueryRequestBody:= int64(1768045152498)
	fromCreateAdhocQueryRequestBody:= int64(1768044252498)
	queryTypeCreateAdhocQueryRequestBody:= "QUERY"
	queryCreateAdhocQueryRequestBody:= "SELECT * FROM s_afdasdf"
	sessionIdCreateAdhocQueryRequestBody:= "AFBF91E7-6AF0-419C-8611-DB6F5D42057D"
	request.Body = &model.CreateAdhocQueryRequestBody{
		TimeZone: &timeZoneCreateAdhocQueryRequestBody,
		To: &toCreateAdhocQueryRequestBody,
		From: &fromCreateAdhocQueryRequestBody,
		QueryType: &queryTypeCreateAdhocQueryRequestBody,
		Query: &queryCreateAdhocQueryRequestBody,
		SessionId: &sessionIdCreateAdhocQueryRequestBody,
	}
	response, err := client.CreateAdhocQuery(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Response body for creating an ad hoc query.

400

Error response.

Error Codes

See Error Codes.