更新时间:2026-02-05 GMT+08:00
分享

创建adhoc查询 - CreateAdhocQuery

功能介绍

创建adhoc查询

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

session_id

String

UUID

query

String

具体查询

query_type

String

查询类型

from

Long

起始范围

to

Long

终止范围

script_params

Array of ScriptParam objects

脚本参数列表

time_zone

String

时区

sql_render_from

Long

起始范围

sql_render_to

Long

终止范围

source_page

String

源页

表4 ScriptParam

参数

是否必选

参数类型

描述

key

String

value

String

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

operate_id

String

操作ID

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

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

响应示例

状态码:200

创建adhoc查询响应体

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

SDK代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

创建adhoc查询响应体

400

错误响应

错误码

请参见错误码

相关文档