All Products
Search
Document Center

Cloud Firewall:DescribeInvadeEventList

Last Updated:Sep 02, 2024

Queries the information about the breach awareness events of a firewall.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cloudfirewall:DescribeInvadeEventListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpdeprecatedstringNo

The source IP address of the request.

192.0.XX.XX
LangstringNo

The language of the content within the response. Valid values:

  • zh: Chinese (default)
  • en: English
zh
StartTimestringNo

The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the query starts from 30 days before the current time.

1656750960
EndTimestringNo

The end of the time range to query. The value is a UNIX timestamp. Unit: seconds. If you do not specify this parameter, the query ends at the current time.

1656837360
CurrentPagestringNo

The number of the page to return.

Default value: 1.

1
PageSizestringNo

The number of entries to return on each page.

Default value: 6. Maximum value: 10.

1
AssetsInstanceIdstringNo

The ID of the instance.

ins_1321_asedb_****
AssetsInstanceNamestringNo

The name of the instance.

ECS_test
IsIgnorestringNo

Specifies whether the breach awareness event is ignored. Valid values:

  • true: The breach awareness event is ignored.
  • false: The breach awareness event is not ignored.
true
AssetsIPstringNo

The IP address of the affected asset.

10.0.XX.XX
EventKeystringNo

The ID of the breach awareness event.

69d189e2-ec17-4676-a2fe-02969234****
EventNamestringNo

The name of the breach awareness event.

event_test
EventUuidstringNo

The UUID of the breach awareness event.

fadd-dfdd-****
MemberUidlongNo

The ID of the member.

135809047715****
ProcessStatusListarrayNo

The handling status of breach awareness events.

integerNo

The handling status of the breach awareness event. Valid values:

  • 0: unhandled
  • 20: handled
0
RiskLevelarrayNo

The risk levels.

integerNo

The risk level. Valid values:

  • 1: low
  • 2: medium
  • 3: high
3

Response parameters

ParameterTypeDescriptionExample
object
LowLevelPercentinteger

The percentage of low-risk events.

20
RequestIdstring

The ID of the request.

F0F82705-CFC7-5F83-86C8-A063892F****
MiddleLevelPercentinteger

The percentage of medium-risk events.

40
HighLevelPercentinteger

The percentage of high-risk events.

40
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of breach awareness events.

40
EventListarray<object>

An array that consists of breach awareness events.

object
RiskLevelinteger

The risk level. Valid values:

  • 1: low
  • 2: medium
  • 3: high
1
EventNamestring

The name of the breach awareness event.

event_test
EventKeystring

The ID of the breach awareness event.

69d189e2-ec17-4676-a2fe-02969234****
EventUuidstring

The UUID of the breach awareness event.

fadd-dfdd-****
MemberUidstring

The ID of the member.

135809047715****
AssetsTypestring

The type of the affected asset. Valid values:

  • BastionHostIP: the egress IP address of a bastion host
  • BastionHostIngressIP: the ingress IP address of a bastion host
  • EcsEIP: the elastic IP address (EIP) of an Elastic Compute Service (ECS) instance
  • EcsPublicIP: the public IP address of an ECS instance
  • EIP: the EIP
  • EniEIP: the EIP of an elastic network interface (ENI)
  • NatEIP: the EIP of a NAT gateway
  • SlbEIP: the EIP of a Server Load Balancer (SLB) instance
  • SlbPublicIP: the public IP address of an SLB instance
  • NatPublicIP: the public IP address of a NAT gateway
  • HAVIP: the high-availability virtual IP address (HAVIP)
EcsPublicIp
FirstTimeinteger

The time when the breach awareness event first occurred. The value is a UNIX timestamp. Unit: seconds.

1656750960
EventSrcstring

The type of the breach awareness event. Valid values:

  • IPS: intrusion prevention event
  • offline: disconnection event
IPS
PrivateIPstring

The private IP address of the affected asset.

192.168.XX.XX
AssetsInstanceNamestring

The name of the affected asset.

ECS_test
LastTimeinteger

The time when the breach awareness event last occurred. The value is a UNIX timestamp. Unit: seconds.

1656837360
PublicIpTypestring

The type of the affected asset. Valid values:

  • BastionHostIP: the egress IP address of a bastion host
  • BastionHostIngressIP: the ingress IP address of a bastion host
  • EcsEIP: the EIP of an ECS instance
  • EcsPublicIP: the public IP address of an ECS instance
  • EIP: the EIP
  • EniEIP: the EIP of an ENI
  • NatEIP: the EIP of a NAT gateway
  • SlbEIP: the EIP of an SLB instance
  • SlbPublicIP: the public IP address of an SLB instance
  • NatPublicIP: the public IP address of a NAT gateway
  • HAVIP: the HAVIP
EcsPublicIp
IsIgnoreboolean

Indicates whether the breach awareness event is ignored. Valid values:

  • true: The breach awareness event is ignored.
  • false: The breach awareness event is not ignored.
true
PublicIPstring

The public IP address of the affected asset.

198.51.XX.XX
ProcessStatusinteger

The handling status of the breach awareness event. Valid values:

  • 0: unhandled
  • 20: handled
20
AssetsInstanceIdstring

The ID of the affected asset.

i-ECS****

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-07-07Add OperationView Change Details