擷取入侵防禦事件的詳細資料。
介面說明
本介面用於查詢和下載入侵防禦詳細資料,建議一次查詢 5~10 條。為避免查詢逾時,如果無需返回 IP 地理位置資訊,請設定參數 NoLocation 為 true。
QPS 限制
本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Lang |
string |
否 |
請求和接收訊息的語言類型。取值:
|
zh |
| Lang |
string |
否 |
請求和接收訊息的語言類型。取值:
|
zh |
| StartTime |
string |
是 |
設定查詢開始時間。使用秒級時間戳記格式表示。 |
1534408189 |
| EndTime |
string |
是 |
設定查詢結束時間。使用秒級時間戳記格式表示。 |
1534408267 |
| Direction |
string |
否 |
入侵防禦事件的流量的方向。取值:
說明
不設定該參數表示查詢所有流量方向。 |
in |
| PageSize |
string |
否 |
設定分頁查詢每頁包含多少條結果。 預設值為 6,表示每頁包含 6 條結果。最大值為 10。 |
6 |
| CurrentPage |
string |
否 |
設定分頁查詢返回第幾頁資料。 預設值為 1,表示返回第 1 頁資料。 |
1 |
| DataType |
string |
是 |
風險事件類型。 |
session |
| RuleSource |
string |
否 |
入侵防禦事件的檢測規則來源。取值:
說明
不設定該參數表示查詢所有規則來源。 |
1 |
| RuleResult |
string |
否 |
Cloud Firewall的防禦狀態。取值:
說明
不設定該參數表示查詢所有防禦狀態。 |
1 |
| SrcIP |
string |
否 |
要查詢的源 IP。設定該參數表示查詢包含了這條源 IP 的入侵防禦事件。 |
192.0.XX.XX |
| DstIP |
string |
否 |
要查詢的目的 IP。設定該參數表示查詢包含了這條目的 IP 的入侵防禦事件。 |
192.0.XX.XX |
| VulLevel |
string |
否 |
入侵防禦事件的安全等級。取值:
說明
不設定該參數表示查詢所有安全等級。 |
1 |
| FirewallType |
string |
否 |
Cloud Firewall類型。取值:
|
InternetFirewall |
| SrcNetworkInstanceId |
string |
否 |
源 VPC 執行個體 ID。 說明
僅在 FirewallType 為 VpcFirewall 時,需要設定該參數。 |
vpc-uf6e9a9zyokj2ywuo**** |
| DstNetworkInstanceId |
string |
否 |
目的 VPC 執行個體 ID。 說明
僅在 FirewallType 為 VpcFirewall 時,需要設定該參數。 |
vpc-uf6e9a9zyokj2ywuo**** |
| AttackType |
string |
否 |
入侵防禦事件的攻擊類型。取值:
說明
不設定該參數表示查詢全部攻擊類型。 |
1 |
| NoLocation |
string |
否 |
是否查詢 IP 位址位置資訊。
|
false |
| AttackApp |
array |
否 |
被攻擊應用的名稱的列表,使用 |
["MySql","DNS"] |
|
string |
否 |
被攻擊應用的名稱的列表,使用 |
Redis |
|
| BuyVersion |
integer |
否 |
購買版本。取值:
|
10 |
| Sort |
string |
否 |
根據指定欄位排序。取值:
|
LastTime |
| Order |
string |
否 |
排序方式。取值:
|
desc |
| EventName |
string |
否 |
入侵防禦事件名稱。 |
wooden horse rear door communication |
| IsOnlyPrivateAssoc |
string |
否 |
是否僅查詢已完成私網溯源的資料。 |
true |
| AttackAppCategory |
array |
否 |
被攻擊應用的類別的列表,使用["AttackAppCategory1","AttackAppCategory2"]格式表示。 |
|
|
string |
否 |
被攻擊應用的類別的列表,使用["AttackAppCategory1","AttackAppCategory2"]格式表示。 |
AI Component |
調用 API 時,除了本文中該 API 的請求參數,還需加入阿里雲 API 公用請求參數。公用請求參數的詳細介紹,請參見公用參數。 調用 API 的請求格式,請參見本文樣本中的請求樣本。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
入侵防禦事件的詳細資料。 |
||
| TotalCount |
integer |
風險事件的總數量。 |
20 |
| RequestId |
string |
本次請求的 ID。 |
B14757D0-4640-4B44-AC67-7F558FE7E6EF |
| DataList |
array<object> |
返回資料列表。 |
|
|
array<object> |
返回資料列表。 |
||
| Direction |
string |
該入侵防禦事件的流量方向。取值:
|
in |
| EventName |
string |
入侵防禦事件名稱。 |
Web Directory Traversal Attack |
| DstIP |
string |
查詢到的目的 IP。表示入侵防禦事件中包含了這條目的 IP。 |
192.0.XX.XX |
| AttackType |
integer |
該入侵防禦事件的攻擊類型。取值:
|
1 |
| Tag |
string |
重保情報標籤。 |
test-tag |
| RuleId |
string |
本次入侵防禦事件的防護規則 ID。 |
1000**** |
| EventId |
string |
入侵防禦事件 ID。 |
2b58efae-4c4b-4d96-9544-a586fb1f**** |
| ResourceType |
string |
該入侵防禦事件的公網 IP 類型。取值:
|
EcsPublicIP |
| FirstEventTime |
integer |
入侵事件首次發生時間。使用秒級時間戳記格式表示。 |
1534408189 |
| Description |
string |
該入侵防禦事件的描述。 |
A directory traversal attack was detected in Web access for HTTP requests |
| EventCount |
integer |
入侵防禦事件數目。 |
100 |
| VulLevel |
integer |
該入侵防禦事件的安全等級。取值:
|
1 |
| AttackApp |
string |
被攻擊應用的名稱。 |
MySql |
| RuleSource |
integer |
本次入侵防禦事件的檢測規則來源。取值:
|
1 |
| RuleResult |
integer |
防禦狀態。取值:
|
2 |
| SrcIP |
string |
查詢到的源 IP。表示入侵防禦事件中包含了這條源 IP。 |
192.0.XX.XX |
| LastEventTime |
integer |
入侵防禦事件上次發生的時間。使用秒級時間戳記格式表示。 |
1534408267 |
| ResourcePrivateIPList |
array<object> |
該入侵防禦事件的私網 IP 資訊,以 RegionNo、ResourceInstanceId、ResourceInstanceName 和 ResourcePrivateIP 的數組形式返回該 IP 資訊。 |
|
|
object |
該入侵防禦事件的私網 IP 資訊,以 RegionNo、ResourceInstanceId、ResourceInstanceName 和 ResourcePrivateIP 的數組形式返回該 IP 資訊。 |
||
| ResourceInstanceName |
string |
執行個體名。 |
LD-shenzhen-zy**** |
| ResourcePrivateIP |
string |
私網 IP。 |
10.255.XX.XX |
| ResourceInstanceId |
string |
執行個體 ID。 |
i-wz92jf4scg2zb74p**** |
| RegionNo |
string |
地區 ID。表示私網 IP 所屬的地區 ID。 |
cn-hangzhou |
| SrcPrivateIPList |
array |
入侵防禦事件的源私網 IP 列表。 |
|
|
string |
入侵防禦事件的源私網 IP 列表。 說明
只有出方向會返回該參數的值。 |
["192.168.XX.XX","192.168.XX.XX"] |
|
| VpcSrcInfo |
object |
該入侵防禦事件的源 VPC 資訊,該結構體包含 EcsInstanceId、EcsInstanceName、NetworkInstanceId、NetworkInstanceName 和 RegionNo 參數。 |
|
| EcsInstanceName |
string |
ECS 執行個體名。 |
LD-shenzhen-zy**** |
| NetworkInstanceName |
string |
VPC 執行個體名。 |
VPC-SH-TX**** |
| NetworkInstanceId |
string |
VPC 執行個體 ID。 |
vpc-uf6e9a9zyokj2ywuo**** |
| EcsInstanceId |
string |
ECS 執行個體 ID。 |
i-wz92jf4scg2zb74p**** |
| RegionNo |
string |
地區 ID。表示源 VPC 執行個體所屬的地區 ID。 |
cn-hangzhou |
| VpcDstInfo |
object |
該入侵防禦事件的目的 VPC 資訊,該結構體包含 EcsInstanceId、EcsInstanceName、NetworkInstanceId、NetworkInstanceName 和 RegionNo 參數。 |
|
| EcsInstanceName |
string |
ECS 執行個體名。 |
LD-shenzhen-zy**** |
| NetworkInstanceName |
string |
VPC 執行個體名。 |
VPC-SH-TX**** |
| NetworkInstanceId |
string |
VPC 執行個體 ID。 |
vpc-uf6e9a9zyokj2ywuo**** |
| EcsInstanceId |
string |
ECS 執行個體 ID。 |
i-wz92jf4scg2zb74p**** |
| RegionNo |
string |
地區 ID。表示目的 VPC 執行個體所屬的地區 ID。 |
cn-hangzhou |
| IPLocationInfo |
object |
IP 地理位置資訊,該結構體包含 CityId、CityName、CountryId 和 CountryName 參數。 |
|
| CityId |
string |
城市 ID。 |
510100 |
| CountryName |
string |
國家名。 |
China |
| CityName |
string |
城市名。 |
Chengdu |
| CountryId |
string |
國家 ID。 |
CN |
SrcIPTag
deprecated
|
string |
源 IP 標籤,用於標識是否為雲產品回源 IP。 |
WAF Back-to-origin Address |
| SrcIPTags |
array |
IP 標籤列表。 |
|
|
string |
IP 標籤。 |
Anti-DDoS Back-to-origin Address |
樣本
正常返回樣本
JSON格式
{
"TotalCount": 20,
"RequestId": "B14757D0-4640-4B44-AC67-7F558FE7E6EF",
"DataList": [
{
"Direction": "in",
"EventName": "Web Directory Traversal Attack",
"DstIP": "192.0.XX.XX",
"AttackType": 1,
"Tag": "test-tag",
"RuleId": "1000****",
"EventId": "2b58efae-4c4b-4d96-9544-a586fb1f****",
"ResourceType": "EcsPublicIP",
"FirstEventTime": 1534408189,
"Description": "A directory traversal attack was detected in Web access for HTTP requests",
"EventCount": 100,
"VulLevel": 1,
"AttackApp": "MySql",
"RuleSource": 1,
"RuleResult": 2,
"SrcIP": "192.0.XX.XX",
"LastEventTime": 1534408267,
"ResourcePrivateIPList": [
{
"ResourceInstanceName": "LD-shenzhen-zy****",
"ResourcePrivateIP": "10.255.XX.XX",
"ResourceInstanceId": "i-wz92jf4scg2zb74p****",
"RegionNo": "cn-hangzhou"
}
],
"SrcPrivateIPList": [
"[\"192.168.XX.XX\",\"192.168.XX.XX\"]"
],
"VpcSrcInfo": {
"EcsInstanceName": "LD-shenzhen-zy****",
"NetworkInstanceName": "VPC-SH-TX****",
"NetworkInstanceId": "vpc-uf6e9a9zyokj2ywuo****",
"EcsInstanceId": "i-wz92jf4scg2zb74p****",
"RegionNo": "cn-hangzhou"
},
"VpcDstInfo": {
"EcsInstanceName": "LD-shenzhen-zy****",
"NetworkInstanceName": "VPC-SH-TX****",
"NetworkInstanceId": "vpc-uf6e9a9zyokj2ywuo****",
"EcsInstanceId": "i-wz92jf4scg2zb74p****",
"RegionNo": "cn-hangzhou"
},
"IPLocationInfo": {
"CityId": "510100",
"CountryName": "China",
"CityName": "Chengdu",
"CountryId": "CN"
},
"SrcIPTag": "WAF Back-to-origin Address",
"SrcIPTags": [
"Anti-DDoS Back-to-origin Address"
]
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | ErrorAliUid | Aliuid invalid. | aliuid無效 |
| 400 | ErrorFirewallType | The specified firewall type is invalid. | 無效的防火牆類型 |
| 400 | ErrorParameters | A parameter error occurred. | 參數錯誤 |
| 400 | ErrorDirectionError | The direction is invalid. | 無效的方向 |
| 400 | ErrorIpFormat | The IP address is invalid. | 無效的IP |
| 400 | ErrorRuleSourceError | The rule source is invalid. | 來源錯誤 |
| 400 | ErrorRuleResultError | The rule result is invalid. | 無效的rule result |
| 400 | ErrorVulLevelFailed | VulLevel has failed. | 漏洞等級失敗 |
| 400 | ErrorTimeError | time range invalid. | 時間選擇錯誤,請重新選擇。 |
| 400 | ErrorIntervalError | The interval is invalid. | 無效的時間間隔 |
| 400 | ErrorPageNo | Either page number or page size is invalid. | 無效的page number 或者 page size |
| 400 | ErrorDBSelectError | A database select error occurred. | 內部錯誤:資料庫查詢錯誤 |
| 400 | ErrorMarshalJSON | internal error. | 內部錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。