更新时间:2026-01-29 GMT+08:00
分享

查看分析脚本 - ShowAnalysisScript

功能介绍

查看分析脚本

调用方法

请参见如何调用API

授权信息

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

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/analysis-scripts/{analysis_script_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

analysis_script_id

String

分析脚本 ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

script_id

String

UUID

project_id

String

项目ID

workspace_id

String

工作空间ID

script_name

String

脚本名称

category

String

参数解释:

脚本分类

  • RETRIEVE 检索

  • ANALYSIS 分析

约束限制

不涉及

取值范围:

  • RETRIEVE

  • ANALYSIS

默认值

不涉及

directory

String

脚本目录分组名称,长度在1到256个字符之间。

description

String

脚本的相关描述信息,长度在1到1024个字符之间。

script_type

String

参数解释:

分析脚本类型

  • SEC_MASTER_SQL 安全云脑SQL

  • RETRIEVE_SQL 检索SQL

约束限制

不涉及

取值范围:

  • SEC_MASTER_SQL

  • RETRIEVE_SQL

默认值

不涉及

retrieve_table_id

String

UUID

script

String

脚本内容,长度在1到10240个字符之间。

owner

String

Iam用户ID

script_params

Array of AnalysisScriptParam objects

分析脚本参数列表

create_by

String

Iam用户ID

create_time

Integer

毫秒时间戳

update_by

String

Iam用户ID

update_time

Integer

毫秒时间戳

表4 AnalysisScriptParam

参数

参数类型

描述

key

String

键 key

value

String

值 value

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

响应示例

状态码:200

成功

{
  "category" : "ANALYSIS",
  "create_by" : "97a32a8e599744d894c47c6fde4a239c",
  "create_time" : 1768202763261,
  "description" : "faasdf",
  "directory" : "test2",
  "owner" : "faf",
  "project_id" : "c796dfc5f1644915ae072b7642a2cd93",
  "script" : "select * from i_sec_hss_vul limit 1",
  "script_id" : "b41eb543-25b6-4f78-8907-64b73b93c463",
  "script_name" : "sousuososu",
  "script_type" : "SEC_MASTER_SQL",
  "update_by" : "test_user",
  "update_time" : 1768295636672,
  "workspace_id" : "5317af6c-aea0-4bd2-bd6b-08de5fd3b155"
}

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

    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();
        ShowAnalysisScriptRequest request = new ShowAnalysisScriptRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withAnalysisScriptId("{analysis_script_id}");
        try {
            ShowAnalysisScriptResponse response = client.showAnalysisScript(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
# 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 = ShowAnalysisScriptRequest()
        request.workspace_id = "{workspace_id}"
        request.analysis_script_id = "{analysis_script_id}"
        response = client.show_analysis_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)
 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
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.ShowAnalysisScriptRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.AnalysisScriptId = "{analysis_script_id}"
	response, err := client.ShowAnalysisScript(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功

400

错误响应

错误码

请参见错误码

相关文档