Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Analysis Script Management/ Viewing an Analysis Script
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Viewing an Analysis Script

Function

This API is used to view an analysis script.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/analysis-scripts/{analysis_script_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.

analysis_script_id

Yes

String

Analysis script 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

Response Parameters

Status code: 200

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

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_type

String

Definition

Analysis script type.

  • SEC_MASTER_SQL SecMaster SQL statements

  • RETRIEVE_SQL: retrieval SQL statements

Constraints

N/A

Range

  • SEC_MASTER_SQL

  • RETRIEVE_SQL

Default Value

N/A

retrieve_table_id

String

UUID

script

String

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

owner

String

IAM user ID.

script_params

Array of AnalysisScriptParam objects

Analysis script parameters.

create_by

String

IAM user ID.

create_time

Integer

Timestamp, in ms.

update_by

String

IAM user ID.

update_time

Integer

Timestamp, in ms.
Table 4 AnalysisScriptParam

Parameter

Type

Description

key

String

Key.

value

String

Value.

Status code: 400

Table 5 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

Request succeeded.

400

Error response

Error Codes

See Error Codes.