# 导出事件 - ExportIncidents #### 功能介绍 导出事件列表,若字段是object类型，需要将整个子对象的内容导出 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI POST /v1/{project_id}/workspaces/{workspace_id}/soc/incidents/export 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间id。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | content-type | 是 | String | **参数解释：** 内容类型 - application/json;charset=UTF-8 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json;charset=UTF-8 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | data_object_filters_form | 否 | [DataobjectSearch] object | 搜索列表条件 | | title | 否 | Array of strings | 导出字段列表 | 表4DataobjectSearch | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 分页大小 | | offset | 否 | Integer | 偏移量 | | sort_by | 否 | String | 排序字段：create_time \| update_time | | order | 否 | String | 排序方式：DESC \| ASC | | from_date | 否 | String | 搜索开始时间，例如：2023-02-20T00:00:00.000Z | | to_date | 否 | String | 搜索结束时间，例如：2023-02-27T23:59:59.999Z | | condition | 否 | [condition] object | 搜索条件表达式 | 表5condition | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | conditions | 否 | Array of [conditions] objects | 表达式列表 | | logics | 否 | Array of strings | 表达式名称列表 | 表6conditions | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 表达式名称 | | data | 否 | Array of strings | 表达式内容列表 | #### 响应参数 **状态码：200** 事件列表导出结果文件 **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释:** 错误码 **约束限制:** 不涉及 **取值范围:** 长度为0-64个字符 **默认取值:** 不涉及 | | message | String | **参数解释:** 错误描述 **约束限制:** 不涉及 **取值范围:** 长度为0-1024个字符 **默认取值:** 不涉及 | #### 请求示例 导出满足条件的10条事件，并限定导出字段为ID、名称和严重等级 ``` https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/incidents/export { "title" : [ "id", "title", "severity" ], "data_object_filters_form" : { "limit" : 10, "offset" : 0, "sort_by" : "create_time", "order" : "DESC", "condition" : { "conditions" : [ { "name" : "severity", "data" : [ "severity", "=", "Medium" ] }, { "name" : "handle_status", "data" : [ "handle_status", "=", "Open" ] } ], "logics" : [ "severity", "and", "handle_status" ] }, "from_date" : "2024-01-20T00:00:00.000Z+0800", "to_date" : "2024-01-26T23:59:59.999Z+0800" } } ``` #### 响应示例 无 #### SDK代码示例 SDK代码示例如下。 - [Java] 导出满足条件的10条事件，并限定导出字段为ID、名称和严重等级 ``` 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 ExportIncidentsSolution { 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("")) .build(); ExportIncidentsRequest request = new ExportIncidentsRequest(); request.withWorkspaceId("{workspace_id}"); ExportIncidentsRequestBody body = new ExportIncidentsRequestBody(); List listbodyTitle = new ArrayList<>(); listbodyTitle.add("id"); listbodyTitle.add("title"); listbodyTitle.add("severity"); List listConditionLogics = new ArrayList<>(); listConditionLogics.add("severity"); listConditionLogics.add("and"); listConditionLogics.add("handle_status"); List listConditionsData = new ArrayList<>(); listConditionsData.add("handle_status"); listConditionsData.add("="); listConditionsData.add("Open"); List listConditionsData1 = new ArrayList<>(); listConditionsData1.add("severity"); listConditionsData1.add("="); listConditionsData1.add("Medium"); List listConditionConditions = new ArrayList<>(); listConditionConditions.add( new DataobjectSearchConditionConditions() .withName("severity") .withData(listConditionsData1) ); listConditionConditions.add( new DataobjectSearchConditionConditions() .withName("handle_status") .withData(listConditionsData) ); DataobjectSearchCondition conditionDataObjectFiltersForm = new DataobjectSearchCondition(); conditionDataObjectFiltersForm.withConditions(listConditionConditions) .withLogics(listConditionLogics); DataobjectSearch dataObjectFiltersFormbody = new DataobjectSearch(); dataObjectFiltersFormbody.withLimit(10) .withOffset(0) .withSortBy("create_time") .withOrder(DataobjectSearch.OrderEnum.fromValue("DESC")) .withFromDate("2024-01-20T00:00:00.000Z+0800") .withToDate("2024-01-26T23:59:59.999Z+0800") .withCondition(conditionDataObjectFiltersForm); body.withTitle(listbodyTitle); body.withDataObjectFiltersForm(dataObjectFiltersFormbody); request.withBody(body); try { ExportIncidentsResponse response = client.exportIncidents(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()); } } } ``` - [Python] 导出满足条件的10条事件，并限定导出字段为ID、名称和严重等级 ``` # 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("")) \ .build() try: request = ExportIncidentsRequest() request.workspace_id = "{workspace_id}" listTitlebody = [ "id", "title", "severity" ] listLogicsCondition = [ "severity", "and", "handle_status" ] listDataConditions = [ "handle_status", "=", "Open" ] listDataConditions1 = [ "severity", "=", "Medium" ] listConditionsCondition = [ DataobjectSearchConditionConditions( name="severity", data=listDataConditions1 ), DataobjectSearchConditionConditions( name="handle_status", data=listDataConditions ) ] conditionDataObjectFiltersForm = DataobjectSearchCondition( conditions=listConditionsCondition, logics=listLogicsCondition ) dataObjectFiltersFormbody = DataobjectSearch( limit=10, offset=0, sort_by="create_time", order="DESC", from_date="2024-01-20T00:00:00.000Z+0800", to_date="2024-01-26T23:59:59.999Z+0800", condition=conditionDataObjectFiltersForm ) request.body = ExportIncidentsRequestBody( title=listTitlebody, data_object_filters_form=dataObjectFiltersFormbody ) response = client.export_incidents(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 导出满足条件的10条事件，并限定导出字段为ID、名称和严重等级 ``` 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("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ExportIncidentsRequest{} request.WorkspaceId = "{workspace_id}" var listTitlebody = []string{ "id", "title", "severity", } var listLogicsCondition = []string{ "severity", "and", "handle_status", } var listDataConditions = []string{ "handle_status", "=", "Open", } var listDataConditions1 = []string{ "severity", "=", "Medium", } nameConditions:= "severity" nameConditions1:= "handle_status" var listConditionsCondition = []model.DataobjectSearchConditionConditions{ { Name: &nameConditions, Data: &listDataConditions1, }, { Name: &nameConditions1, Data: &listDataConditions, }, } conditionDataObjectFiltersForm := &model.DataobjectSearchCondition{ Conditions: &listConditionsCondition, Logics: &listLogicsCondition, } limitDataObjectFiltersForm:= int32(10) offsetDataObjectFiltersForm:= int32(0) sortByDataObjectFiltersForm:= "create_time" orderDataObjectFiltersForm:= model.GetDataobjectSearchOrderEnum().DESC fromDateDataObjectFiltersForm:= "2024-01-20T00:00:00.000Z+0800" toDateDataObjectFiltersForm:= "2024-01-26T23:59:59.999Z+0800" dataObjectFiltersFormbody := &model.DataobjectSearch{ Limit: &limitDataObjectFiltersForm, Offset: &offsetDataObjectFiltersForm, SortBy: &sortByDataObjectFiltersForm, Order: &orderDataObjectFiltersForm, FromDate: &fromDateDataObjectFiltersForm, ToDate: &toDateDataObjectFiltersForm, Condition: conditionDataObjectFiltersForm, } request.Body = &model.ExportIncidentsRequestBody{ Title: &listTitlebody, DataObjectFiltersForm: dataObjectFiltersFormbody, } response, err := client.ExportIncidents(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ExportIncidents&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 事件列表导出结果文件 | | 400 | 导出事件列表错误返回body体 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。