Updated on 2026-02-05 GMT+08:00

Creating a Retrieval Script

Function

This API is used to create a retrieval script.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/siem/retrieve-scripts

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

table_id

Yes

String

UUID

script_name

Yes

String

Script name.

category

Yes

String

Definition

Script category.

  • RETRIEVE: retrieval

  • ANALYSIS: analysis

Constraints

N/A

Range

  • RETRIEVE

  • ANALYSIS

Default Value

N/A

directory

No

String

Script directory group name. Length: 1 to 256 characters.

description

No

String

Script description. Length: 1 to 1,024 characters.

script

Yes

String

Script content. Length: 1 to 10,240 characters.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

script_id

String

UUID

project_id

String

Project ID.

workspace_id

String

Workspace ID.

script_name

String

Script name.

table_id

String

UUID

category

String

Definition

Script category.

  • RETRIEVE: retrieval

  • ANALYSIS: analysis

Constraints

N/A

Range

  • RETRIEVE

  • ANALYSIS

Default Value

N/A

directory

String

Script directory group name. Length: 1 to 256 characters.

description

String

Script description. Length: 1 to 1,024 characters.

script

String

Script content. Length: 1 to 10,240 characters.

create_by

String

IAM user ID.

create_time

Integer

Timestamp, in ms.

update_by

String

IAM user ID.

update_time

Integer

Timestamp, in ms.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

Create a retrieval script.

https://{endpoint}/v2/{project_id}/workspaces/{workspace_id}/siem/retrieve-scripts

{
  "table_id" : "f0679e6b-f065-4f21-a742-487797a50e7f",
  "script_name" : "test_log",
  "directory" : "",
  "description" : "",
  "script" : "limit 1",
  "category" : 0
}

Example Responses

Status code: 200

Request succeeded.

{
  "category" : "RETRIEVE",
  "create_by" : "test_user",
  "create_time" : 1768534520786,
  "description" : "",
  "directory" : "",
  "project_id" : "c796dfc5f1644915ae072b7642a2cd93",
  "script" : "limit 1",
  "script_id" : "cf94b053-92fe-4678-a445-f227268cc6eb",
  "script_name" : "test_log",
  "table_id" : "f0679e6b-f065-4f21-a742-487797a50e7f",
  "update_by" : "test_user",
  "update_time" : 1768534520786,
  "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155"
}

SDK Sample Code

The SDK sample code is as follows.

Create a retrieval script.

 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 CreateRetrieveScriptSolution {

    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();
        CreateRetrieveScriptRequest request = new CreateRetrieveScriptRequest();
        request.withWorkspaceId("{workspace_id}");
        CreateRetrieveScriptRequestBody body = new CreateRetrieveScriptRequestBody();
        body.withScript("limit 1");
        body.withDescription("");
        body.withDirectory("");
        body.withCategory(CreateRetrieveScriptRequestBody.CategoryEnum.fromValue("0"));
        body.withScriptName("test_log");
        body.withTableId("f0679e6b-f065-4f21-a742-487797a50e7f");
        request.withBody(body);
        try {
            CreateRetrieveScriptResponse response = client.createRetrieveScript(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());
        }
    }
}

Create a retrieval script.

 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 = CreateRetrieveScriptRequest()
        request.workspace_id = "{workspace_id}"
        request.body = CreateRetrieveScriptRequestBody(
            script="limit 1",
            description="",
            directory="",
            category="0",
            script_name="test_log",
            table_id="f0679e6b-f065-4f21-a742-487797a50e7f"
        )
        response = client.create_retrieve_script(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Create a retrieval script.

 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
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.CreateRetrieveScriptRequest{}
	request.WorkspaceId = "{workspace_id}"
	descriptionCreateRetrieveScriptRequestBody:= ""
	directoryCreateRetrieveScriptRequestBody:= ""
	categoryCategory:= model.GetScriptCategoryCategoryEnum().E_0
	request.Body = &model.CreateRetrieveScriptRequestBody{
		Script: "limit 1",
		Description: &descriptionCreateRetrieveScriptRequestBody,
		Directory: &directoryCreateRetrieveScriptRequestBody,
		Category: &categoryCategory,
		ScriptName: "test_log",
		TableId: "f0679e6b-f065-4f21-a742-487797a50e7f",
	}
	response, err := client.CreateRetrieveScript(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

Request succeeded.

400

Error response.

Error Codes

See Error Codes.