文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 告警管理/ 告警转事件 - CreateBatchOrderAlerts
更新时间:2026-06-26 GMT+08:00
分享

告警转事件 - CreateBatchOrderAlerts

功能介绍

告警转事件

调用方法

请参见如何调用API

授权信息

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

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/alerts/batch-order

表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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

ids

Array of strings

参数解释:

转事件的告警id列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

incident_content

incident_content object

参数解释:

事件内容

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 incident_content

参数

是否必选

参数类型

描述

title

String

参数解释:

事件名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

incident_type

incident_type object

参数解释:

事件类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表5 incident_type

参数

是否必选

参数类型

描述

id

String

参数解释:

事件类型id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

category

String

参数解释:

事件类型父类

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

incident_type

String

参数解释:

事件类型子类

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,格式为:request_uuid-timestamp-hostname

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

message

String

参数解释:

错误信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

data

BatchOperateAlertResult object

参数解释:

批量操作告警返回对象

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表8 BatchOperateAlertResult

参数

参数类型

描述

error_ids

Array of strings

参数解释:

失败id列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

success_ids

Array of strings

参数解释:

成功id列表

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,格式为:request_uuid-timestamp-hostname

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表10 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

约束限制:

不涉及

取值范围:

长度为0-64个字符

默认取值:

不涉及

message

String

参数解释:

错误描述

约束限制:

不涉及

取值范围:

长度为0-1024个字符

默认取值:

不涉及

请求示例

将一条告警转为事件,告警ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,事件类型为Rootkit

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/alerts/batch-order

{
  "ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ],
  "incident_content" : {
    "title" : "demo_title",
    "incident_type" : {
      "id" : "b03166f1b63f021663d9889c6274c27e",
      "category" : "Malware",
      "incident_type" : "Rootkit"
    }
  }
}

响应示例

状态码:200

告警转事件返回成功

{
  "code" : "00000000",
  "message" : "message",
  "data" : {
    "error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ],
    "success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ]
  }
}

SDK代码示例

SDK代码示例如下。

将一条告警转为事件,告警ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,事件类型为Rootkit

 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
57
58
59
60
61
62
63
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.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateBatchOrderAlertsSolution {

    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();
        CreateBatchOrderAlertsRequest request = new CreateBatchOrderAlertsRequest();
        request.withWorkspaceId("{workspace_id}");
        OrderAlert body = new OrderAlert();
        OrderAlertIncidentContentIncidentType incidentTypeIncidentContent = new OrderAlertIncidentContentIncidentType();
        incidentTypeIncidentContent.withId("b03166f1b63f021663d9889c6274c27e")
            .withCategory("Malware")
            .withIncidentType("Rootkit");
        OrderAlertIncidentContent incidentContentbody = new OrderAlertIncidentContent();
        incidentContentbody.withTitle("demo_title")
            .withIncidentType(incidentTypeIncidentContent);
        List<String> listbodyIds = new ArrayList<>();
        listbodyIds.add("909494e3-558e-46b6-a9eb-07a8e18ca62f");
        body.withIncidentContent(incidentContentbody);
        body.withIds(listbodyIds);
        request.withBody(body);
        try {
            CreateBatchOrderAlertsResponse response = client.createBatchOrderAlerts(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());
        }
    }
}

将一条告警转为事件,告警ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,事件类型为Rootkit

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v1 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 = CreateBatchOrderAlertsRequest()
        request.workspace_id = "{workspace_id}"
        incidentTypeIncidentContent = OrderAlertIncidentContentIncidentType(
            id="b03166f1b63f021663d9889c6274c27e",
            category="Malware",
            incident_type="Rootkit"
        )
        incidentContentbody = OrderAlertIncidentContent(
            title="demo_title",
            incident_type=incidentTypeIncidentContent
        )
        listIdsbody = [
            "909494e3-558e-46b6-a9eb-07a8e18ca62f"
        ]
        request.body = OrderAlert(
            incident_content=incidentContentbody,
            ids=listIdsbody
        )
        response = client.create_batch_order_alerts(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

将一条告警转为事件,告警ID为909494e3-558e-46b6-a9eb-07a8e18ca62f,事件类型为Rootkit

 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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := secmaster.SecMasterClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := secmaster.NewSecMasterClient(hcClient)

    request := &model.CreateBatchOrderAlertsRequest{}
	request.WorkspaceId = "{workspace_id}"
	idIncidentType:= "b03166f1b63f021663d9889c6274c27e"
	categoryIncidentType:= "Malware"
	incidentTypeIncidentType:= "Rootkit"
	incidentTypeIncidentContent := &model.OrderAlertIncidentContentIncidentType{
		Id: &idIncidentType,
		Category: &categoryIncidentType,
		IncidentType: &incidentTypeIncidentType,
	}
	titleIncidentContent:= "demo_title"
	incidentContentbody := &model.OrderAlertIncidentContent{
		Title: &titleIncidentContent,
		IncidentType: incidentTypeIncidentContent,
	}
	var listIdsbody = []string{
        "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    }
	request.Body = &model.OrderAlert{
		IncidentContent: incidentContentbody,
		Ids: &listIdsbody,
	}
	response, err := client.CreateBatchOrderAlerts(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

告警转事件返回成功

400

告警转事件错误返回失败

错误码

请参见错误码

相关文档