Submitting a Vulnerability Export Request
Function
This API is used to request for exporting intrusion events.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
POST /v5/{project_id}/event/export
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
enterprise_project_id | No | String | Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project. |
last_days | No | Integer | Definition Number of days to be queried. This parameter is manually exclusive with begin_time and end_time. Constraints N/A Range N/A Default Value N/A |
host_name | No | String | Definition Server name. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A |
host_id | No | String | Definition Server ID. Constraints N/A Range Length: 1 to 256 characters Default Value N/A |
private_ip | No | String | Definition Server private IP address. Constraints N/A Range Length: 1 to 128 characters Default Value N/A |
container_name | No | String | Definition Container instance name. Constraints N/A Range The value can contain 1 to 512 characters. Default Value N/A |
offset | No | Integer | Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range N/A Default Value N/A |
limit | No | Integer | Definition Number of records displayed on each page. Constraints N/A Range N/A Default Value N/A |
export_size | No | Integer | Definition Quantity Constraints N/A Range N/A Default Value N/A |
event_type | No | Integer | Definition Event type Constraints N/A Range Default Value N/A |
event_types | No | Array of integers | Definition Event type Range Default Value N/A |
handle_status | No | String | Definition Handling status. Constraints N/A Range Default Value N/A |
severity | No | String | Definition Risk level. Constraints N/A Range Default Value N/A |
category | Yes | String | Definition Event type. Constraints N/A Range Default Value N/A |
begin_time | No | Long | Definition Customized start time of a segment. The timestamp is accurate to milliseconds. The end_time should be no more than two days earlier than the begin_time. This parameter is mutually exclusive with the queried duration. Constraints N/A Range N/A Default Value N/A |
end_time | No | Long | Definition Customized end time of a query time range. The timestamp is accurate to milliseconds. The end_time should be no more than two days earlier than the begin_time. This parameter is mutually exclusive with the queried duration. Constraints N/A Range N/A Default Value N/A |
event_class_ids | No | Array of strings | Definition Event ID. Constraints N/A Range
Default Value N/A |
severity_list | No | Array of strings | Definition Risk level. Constraints N/A Range Default Value N/A |
attack_tag | No | String | Definition Attack tag. Constraints N/A Range Default Value N/A |
asset_value | No | String | Definition Asset importance. Constraints N/A Range Default Value N/A |
tag_list | No | Array of strings | Definition Event tag list. Constraints N/A Range N/A Default Value N/A |
att_ck | No | String | Definition ATT&CK phase. Constraints N/A Range Default Value N/A |
event_name | No | String | Definition Alarm name. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A |
event_id_list | No | Array of strings | Definition Alarm ID set. Constraints N/A Range N/A Default Value N/A |
auto_block | No | Boolean | Definition Whether to automatically block alarms. Constraints N/A Range Default Value N/A |
cluster_id | No | String | Definition Cluster ID. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A |
event_id | Yes | String | Definition Case code. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A |
public_ip | No | String | Definition Server EIP. Constraints N/A Range Length: 1 to 128 characters Default Value N/A |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
[items] | Yes | Array of ExportHead objects | Definition Export data table header details. Constraints The table header information must be in the following format**: [[Field 1, Display name of table header 1], [Field 2, Display name of table header 2], [Field 3, Display name of table header 3]] Range You can select some or all of the following values to form the table header information. All assets have the following fields**:
Default Value N/A |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
record_total_num | Integer | Definition Total number of exported records. Range N/A |
task_id | String | Definition Export task ID. Range N/A |
Example Requests
[ [ [ "app_name", "Software name" ], [ "version", "Version" ], [ "update_time", "Update time." ], [ "recent_scan_time", "Last scan time." ], [ "container_id", "Container ID" ], [ "container_name", "Container name" ], [ "host_name", "Server name." ], [ "host_ip", "Server IP address." ] ] ]
Example Responses
Status code: 200
Request succeeded.
{
"record_total_num" : 1,
"task_id" : "asdwwqdtut01"
} Status Codes
Status Code | Description |
|---|---|
200 | Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
