Queries a list of breach awareness events detected by Cloud Firewall.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Lang |
string |
No |
The language of the response. Valid values:
|
zh |
SourceIp
deprecated
|
string |
No |
The source IP address of the visitor. |
192.0.XX.XX |
| Lang |
string |
No |
The language of the response. Valid values:
|
zh |
| StartTime |
string |
No |
The start time for the query. This value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the query starts from 30 days ago. |
1656750960 |
| EndTime |
string |
No |
The end time for the query. This value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the query ends at the current time. |
1656837360 |
| CurrentPage |
string |
No |
The number of the page to return. Default value: 1. |
1 |
| PageSize |
string |
No |
The number of entries to return on each page. Default value: 6. Maximum value: 10. |
1 |
| AssetsInstanceId |
string |
No |
The instance ID. |
ins_1321_asedb_**** |
| AssetsInstanceName |
string |
No |
The instance name. |
ECS_test |
| IsIgnore |
string |
No |
Specifies whether the breach awareness event is ignored. Valid values:
|
true |
| AssetsIP |
string |
No |
The IP address of the affected asset. |
10.0.XX.XX |
| EventKey |
string |
No |
The ID of the breach awareness event. |
69d189e2-ec17-4676-a2fe-02969234**** |
| EventName |
string |
No |
The name of the breach awareness event. |
event_test |
| EventUuid |
string |
No |
The UUID of the breach awareness event. |
fadd-dfdd-**** |
| MemberUid |
integer |
No |
The UID of the member account. |
135809047715**** |
| ProcessStatusList |
array |
No |
A list of processing statuses. |
|
|
integer |
No |
The processing status of the breach awareness event. Valid values:
|
0 |
|
| RiskLevel |
array |
No |
The risk levels. |
|
|
integer |
No |
The risk level. Valid values:
|
3 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| LowLevelPercent |
integer |
The percentage of low-risk events. |
20 |
| RequestId |
string |
The ID of the request. |
F0F82705-CFC7-5F83-86C8-A063892F**** |
| MiddleLevelPercent |
integer |
The percentage of medium-risk events. |
40 |
| HighLevelPercent |
integer |
The percentage of high-risk events. |
40 |
| PageInfo |
object |
The pagination information. |
|
| CurrentPage |
integer |
The page number of the returned page. |
1 |
| PageSize |
integer |
The number of entries per page. |
10 |
| TotalCount |
integer |
The total number of breach awareness events. |
40 |
| EventList |
array<object> |
The list of breach awareness events. |
|
|
object |
|||
| RiskLevel |
integer |
The risk level. Valid values:
|
1 |
| EventName |
string |
The name of the breach awareness event. |
event_test |
| EventKey |
string |
The ID of the breach awareness event. |
69d189e2-ec17-4676-a2fe-02969234**** |
| EventUuid |
string |
The UUID of the breach awareness event. |
fadd-dfdd-**** |
| MemberUid |
string |
The UID of the member account. |
135809047715**** |
| AssetsType |
string |
The type of the affected asset. Valid values:
|
EcsPublicIp |
| FirstTime |
integer |
The time when the breach awareness event first occurred. This value is a UNIX timestamp. Unit: seconds. |
1656750960 |
| EventSrc |
string |
The source of the breach awareness event. Valid values:
|
IPS |
| PrivateIP |
string |
The private IP address of the affected asset. |
192.168.XX.XX |
| AssetsInstanceName |
string |
The name of the affected asset. |
ECS_test |
| LastTime |
integer |
The time when the breach awareness event last occurred. This value is a UNIX timestamp. Unit: seconds. |
1656837360 |
| PublicIpType |
string |
The type of the affected asset. Valid values:
|
EcsPublicIp |
| IsIgnore |
boolean |
Indicates whether the breach awareness event is ignored. Valid values:
|
true |
| PublicIP |
string |
The public IP address of the affected asset. |
198.51.XX.XX |
| ProcessStatus |
integer |
The processing status of the breach awareness event. Valid values:
|
20 |
| AssetsInstanceId |
string |
The instance ID of the affected asset. |
i-ECS**** |
Examples
Success response
JSON format
{
"LowLevelPercent": 20,
"RequestId": "F0F82705-CFC7-5F83-86C8-A063892F****",
"MiddleLevelPercent": 40,
"HighLevelPercent": 40,
"PageInfo": {
"CurrentPage": 1,
"PageSize": 10,
"TotalCount": 40
},
"EventList": [
{
"RiskLevel": 1,
"EventName": "event_test",
"EventKey": "69d189e2-ec17-4676-a2fe-02969234****",
"EventUuid": "fadd-dfdd-****",
"MemberUid": "135809047715****",
"AssetsType": "EcsPublicIp",
"FirstTime": 1656750960,
"EventSrc": "IPS",
"PrivateIP": "192.168.XX.XX",
"AssetsInstanceName": "ECS_test",
"LastTime": 1656837360,
"PublicIpType": "EcsPublicIp",
"IsIgnore": true,
"PublicIP": "198.51.XX.XX",
"ProcessStatus": 20,
"AssetsInstanceId": "i-ECS****"
}
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ErrorAliUid | Aliuid invalid. | The aliuid is invalid. |
| 400 | ErrorDBSelectError | A database select error occurred. | The error message returned because an internal error has occurred in querying the database. |
| 400 | ErrorUnMarshalJSON | internal error. | Internal Error |
| 400 | ErrorMarshalJSON | internal error. | Internal error. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.