导出漏洞请求 - ExportEventRequest
功能介绍
导出入侵事件请求。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/event/export
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
last_days |
否 |
Integer |
参数解释： 查询时间范围天数，与自定义查询时间begin_time，end_time互斥 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
host_name |
否 |
String |
参数解释： 服务器名称 约束限制： 不涉及 取值范围： 字符长度1-64位 默认取值： 不涉及 |
|
host_id |
否 |
String |
参数解释： 服务器ID 约束限制： 不涉及 取值范围： 字符长度1-256位 默认取值： 不涉及 |
|
private_ip |
否 |
String |
参数解释： 服务器私有IP 约束限制： 不涉及 取值范围： 字符长度1-128位 默认取值： 不涉及 |
|
container_name |
否 |
String |
参数解释： 容器实例名称 约束限制： 不涉及 取值范围： 字符长度1-512位 默认取值： 不涉及 |
|
offset |
否 |
Integer |
参数解释： 偏移量：指定返回记录的开始位置 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
limit |
否 |
Integer |
参数解释： 每页显示个数 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
export_size |
否 |
Integer |
参数解释： 导出数量 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
event_type |
否 |
Integer |
参数解释： 事件类型 约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
event_types |
否 |
Array of integers |
参数解释： 事件类型 约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
handle_status |
否 |
String |
参数解释: 处置状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
severity |
否 |
String |
参数解释: 威胁等级 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
category |
是 |
String |
参数解释： 事件类别 约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
begin_time |
否 |
Long |
参数解释： 自定义查询时间，与查询时间范围天数互斥，查询时间段的起始时间，毫秒级时间戳，end_time减去begin_time小于等于2天，与查询时间范围天数互斥 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
end_time |
否 |
Long |
参数解释： 自定义时间，查询时间段的终止时间，毫秒级时间戳，end_time减去begin_time小于等于2天，与查询时间范围天数互斥 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 |
|
event_class_ids |
否 |
Array of strings |
参数解释： 事件标识 约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
severity_list |
否 |
Array of strings |
参数解释: 威胁等级 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
attack_tag |
否 |
String |
参数解释: 攻击标识 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
asset_value |
否 |
String |
参数解释: 资产重要性 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
tag_list |
否 |
Array of strings |
参数解释: 事件标签列表 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
att_ck |
否 |
String |
参数解释: ATT&CK攻击阶段 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
event_name |
否 |
String |
参数解释： 告警名称 约束限制： 不涉及 取值范围： 字符长度1-128位 默认取值： 不涉及 |
|
event_id_list |
否 |
Array of strings |
参数解释： 告警id集合 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 "" |
|
auto_block |
否 |
Boolean |
参数解释： 是否自动阻断告警 约束限制： 不涉及 取值范围：
默认取值： 不涉及 |
|
cluster_id |
否 |
String |
参数解释: 集群ID 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
event_id |
是 |
String |
参数解释： 事件编号 约束限制： 不涉及 取值范围： 字符长度1-128位 默认取值： 不涉及 |
|
public_ip |
否 |
String |
参数解释： 服务器公网IP 约束限制： 不涉及 取值范围： 字符长度1-128位 默认取值： 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
[数组元素] |
是 |
Array of ExportHead objects |
参数解释: 导出数据表头信息详情 约束限制: 表头信息应为如下格式[[字段1,表头1显示名称],[字段2,表头2显示名称],[字段3,表头3显示名称]] 取值范围: 可从如下取值中选取部分或全部组成表头信息 所有资产都有如下字段：
其他资产类别特有字段： 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
[数组元素] |
否 |
Array of strings |
参数解释: 导出数据表头信息详情 约束限制: 表头信息应为如下格式[[字段1,表头1显示名称],[字段2,表头2显示名称],[字段3,表头3显示名称]] 取值范围: 可从如下取值中选取部分或全部组成表头信息 所有资产都有如下字段：
其他资产类别特有字段： 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
record_total_num |
Integer |
参数解释： 导出记录总数 取值范围： 不涉及 |
|
task_id |
String |
参数解释： 导出任务ID 取值范围： 不涉及 |
请求示例
[ [ [ "app_name", "软件名称" ], [ "version", "版本号" ], [ "update_time", "更新时间" ], [ "recent_scan_time", "最近扫描时间" ], [ "container_id", "容器id" ], [ "container_name", "容器名称" ], [ "host_name", "主机服务器名" ], [ "host_ip", "主机ip" ] ] ]
响应示例
状态码：200
请求已成功
{
"record_total_num" : 1,
"task_id" : "asdwwqdtut01"
}
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 |
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.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ExportEventRequestSolution { 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); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ExportEventRequestRequest request = new ExportEventRequestRequest(); try { ExportEventRequestResponse response = client.exportEventRequest(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 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 = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ExportEventRequestRequest() response = client.export_event_request(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/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 := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ExportEventRequestRequest{} response, err := client.ExportEventRequest(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
