Querying the List of Historical Alarm Records
Function
This API is used to query the list of historical alarm records
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
GET /v5/{project_id}/event/handle-history
| 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. |
| severity | No | String | Threat level. The options are as follows: |
| attack_tag | No | String | Indicates the attack flag. The options are as follows: |
| asset_value | No | String | Definition Asset importance. Constraints N/A Range Default Value None |
| event_class_ids | No | Array of strings | Event ID. Its value can be:
|
| event_name | No | String | Alarm name |
| event_type | No | Integer | Definition Event type. Range |
| host_name | No | String | Definition Server name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A |
| handle_status | No | String | Definition Handling Status Constraints N/A Range Its value can be: Default Value N/A |
| host_ip | No | String | Definition Server IP address Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A |
| limit | Yes | Integer | Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10 |
| offset | Yes | Integer | Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value N/A |
| public_ip | No | String | Definition Server EIP. Constraints N/A Range For IPv4, the value contains 7 to 15 characters. For IPv6, the value contains 15 to 39 characters. Default Value None |
| private_ip | No | String | Definition Server private IP address. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A |
| sort_dir | No | String | Sorting order. If sort_key is set, the returned results are sorted in ascending the order specified by sort_key. The default order is descending. The options are as follows: |
| sort_key | No | String | Sorting fields. The options are as follows: |
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 |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total_num | Integer | Definition Total number. Range The value range is 0 to 2,147,483,647. |
| data_list | Array of EventHandleHistory objects | Historical handling records of alarm events |
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{
"total_num" : 23081,
"data_list" : [ {
"event_class_id" : "graph_0001",
"event_name" : "Suspicious sample execution detected",
"user_name" : "scc_hss_g0***0938_01",
"operate_type" : "do_not_ignore",
"host_name" : "ecs-00****74-windows",
"attack_tag" : "collapsible_host",
"private_ip" : "192.168.0.180",
"public_ip" : "100.93.15.94",
"asset_value" : "common",
"severity" : "Critical",
"occur_time" : 1737511632000,
"handle_status" : "unhandled",
"notes" : "One alarm has been handled.",
"handle_time" : 1737532947313
} ]
} 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