Querying Flow Logs
Function
This API is used to query flow logs.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/cfw/logs/flow
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
fw_instance_id |
Yes |
String |
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ. |
direction |
No |
String |
Direction |
log_type |
No |
String |
Log type Enumeration values:
|
start_time |
Yes |
Long |
Start time |
end_time |
Yes |
Long |
End time |
src_ip |
No |
String |
Source IP address |
src_port |
No |
Integer |
Source port Minimum: 0 Maximum: 65535 |
dst_ip |
No |
String |
Destination IP address |
dst_port |
No |
Integer |
Destination port Minimum: 0 Maximum: 65535 |
protocol |
No |
String |
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. Enumeration values:
|
app |
No |
String |
Application protocol |
log_id |
No |
String |
Document ID. The value is null for the first page and not null for the rest of the pages. |
next_date |
No |
Long |
Date. The value is null for the first page and not null for the rest of the pages. |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0. |
limit |
Yes |
Integer |
Number of records displayed on each page, in the range 1-1024 Minimum: 1 Maximum: 1024 |
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
dst_host |
No |
String |
destination host |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
Value returned for flow log query |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Returned quantity |
limit |
Integer |
Number of records displayed on each page, in the range 1-1024 |
records |
Array of records objects |
Record |
Parameter |
Type |
Description |
---|---|---|
bytes |
Integer |
Byte |
direction |
String |
Direction, which can be inbound or outbound Enumeration values:
|
packets |
Integer |
Packet |
start_time |
Long |
Start time |
end_time |
Long |
End time |
log_id |
String |
Document ID |
src_ip |
String |
Source IP address |
src_port |
Integer |
Source port |
dst_ip |
String |
Destination IP address |
app |
String |
Application protocol |
dst_port |
Integer |
Destination port |
protocol |
String |
Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. |
dst_host |
String |
destination host |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
Query the flow logs on the first page of the firewall with the ID 2af58b7c-893c-4453-a984-bdd9b1bd6318 in the project 9d80d070b6d44942af73c9c3d38e0429. The query time range is 1663555012000 to 1664159798000.
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/flow?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&start_time=1663555012000&end_time=1664159798000&limit=10
Example Responses
Status code: 200
OK
{ "data" : { "limit" : 10, "records" : [ { "app" : "SSH", "bytes" : 34.5, "direction" : "out2in", "dst_ip" : "100.95.148.49", "dst_port" : 22, "end_time" : 1664155493000, "log_id" : "76354", "packets" : 25, "protocol" : "TCP", "src_ip" : "100.93.27.17", "src_port" : 49634, "start_time" : 1664155428000 } ], "total" : 1 } }
Status code: 400
Bad Request
{ "error_code" : "CFW.00500002", "error_msg" : "time range error" }
SDK Sample Code
The SDK sample code is as follows.
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ListFlowLogsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); ListFlowLogsRequest request = new ListFlowLogsRequest(); request.withFwInstanceId("<fw_instance_id>"); request.withDirection("<direction>"); request.withLogType(ListFlowLogsRequest.LogTypeEnum.fromValue("<log_type>")); request.withStartTime(<start_time>L); request.withEndTime(<end_time>L); request.withSrcIp("<src_ip>"); request.withSrcPort(<src_port>); request.withDstIp("<dst_ip>"); request.withDstPort(<dst_port>); request.withProtocol(ListFlowLogsRequest.ProtocolEnum.fromValue("<protocol>")); request.withApp("<app>"); request.withLogId("<log_id>"); request.withNextDate(<next_date>L); request.withOffset(<offset>); request.withLimit(<limit>); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withDstHost("<dst_host>"); try { ListFlowLogsResponse response = client.listFlowLogs(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListFlowLogsRequest() request.fw_instance_id = "<fw_instance_id>" request.direction = "<direction>" request.log_type = "<log_type>" request.start_time = <start_time> request.end_time = <end_time> request.src_ip = "<src_ip>" request.src_port = <src_port> request.dst_ip = "<dst_ip>" request.dst_port = <dst_port> request.protocol = "<protocol>" request.app = "<app>" request.log_id = "<log_id>" request.next_date = <next_date> request.offset = <offset> request.limit = <limit> request.enterprise_project_id = "<enterprise_project_id>" request.dst_host = "<dst_host>" response = client.list_flow_logs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListFlowLogsRequest{} request.FwInstanceId = "<fw_instance_id>" directionRequest:= "<direction>" request.Direction = &directionRequest logTypeRequest:= model.GetListFlowLogsRequestLogTypeEnum().<LOG_TYPE> request.LogType = &logTypeRequest request.StartTime = int64(<start_time>) request.EndTime = int64(<end_time>) srcIpRequest:= "<src_ip>" request.SrcIp = &srcIpRequest srcPortRequest:= int32(<src_port>) request.SrcPort = &srcPortRequest dstIpRequest:= "<dst_ip>" request.DstIp = &dstIpRequest dstPortRequest:= int32(<dst_port>) request.DstPort = &dstPortRequest protocolRequest:= model.GetListFlowLogsRequestProtocolEnum().<PROTOCOL> request.Protocol = &protocolRequest appRequest:= "<app>" request.App = &appRequest logIdRequest:= "<log_id>" request.LogId = &logIdRequest nextDateRequest:= int64(<next_date>) request.NextDate = &nextDateRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest request.Limit = int32(<limit>) enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest dstHostRequest:= "<dst_host>" request.DstHost = &dstHostRequest response, err := client.ListFlowLogs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
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