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, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
fw_instance_id |
Yes |
String |
Firewall ID, which can be obtained by referring to Obtaining a Firewall ID. |
direction |
No |
String |
Direction. Its value can be in2out or out2in. |
log_type |
No |
String |
Log type. Its value can be internet, vpc, or nat. |
start_time |
Yes |
Long |
Start time, in milliseconds. The value is a timestamp, for example, 1718936272648. |
end_time |
Yes |
Long |
End time, in milliseconds. The value is a timestamp, for example, 1718936272648. |
src_ip |
No |
String |
Source IP address. |
src_port |
No |
Integer |
Source port. |
dst_ip |
No |
String |
Destination IP address. |
dst_port |
No |
Integer |
Destination port. |
protocol |
No |
String |
Protocol type. Its value can be TCP, UDP, ICMP, or ICMPv6. |
app |
No |
String |
Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP. |
log_id |
No |
String |
Document ID. For the first page, its value is null. For other pages, its value can be the log_id of the last record in the last query. |
next_date |
No |
Long |
Next date. For the first page, its value is null. For other pages, its value can be the start_time of the last record in the last query. |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. The value must be a number greater than 0. For the first page, its value is null. For other pages, its value is not null. |
limit |
Yes |
Integer |
Number of records displayed on each page. The value ranges from 1 to 1024. |
enterprise_project_id |
No |
String |
Enterprise project ID, which is the ID of a project planned based on organizations. You can obtain the enterprise project ID by referring to Obtaining an Enterprise Project ID. If the enterprise project function is not enabled, the value is 0. |
dst_host |
No |
String |
Destination host. |
src_region_name |
No |
String |
Source region name. |
dst_region_name |
No |
String |
Destination region name. |
src_province_name |
No |
String |
Source province name. |
dst_province_name |
No |
String |
Destination province name. |
src_city_name |
No |
String |
Source city name. |
dst_city_name |
No |
String |
Destination city name. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. You can obtain the token by referring to Obtaining a User Token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
data object |
Return value for querying flow logs. |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of returned records for querying flow logs. |
limit |
Integer |
Number of records displayed on each page. The value ranges from 1 to 1024. |
records |
Array of records objects |
Record. |
Parameter |
Type |
Description |
---|---|---|
bytes |
Double |
Byte. |
direction |
String |
Direction: in2out (outbound) or out2in (inbound). |
packets |
Integer |
Number of packets. |
start_time |
Long |
Start time, in milliseconds. The value is a timestamp, for example, 1718936272648. |
end_time |
Long |
End time, in milliseconds. The value is a timestamp, for example, 1718936272648. |
log_id |
String |
Document ID. |
src_ip |
String |
Source IP address. |
src_port |
Integer |
Source port. |
dst_ip |
String |
Destination IP address. |
app |
String |
Rule application type. Its value can be HTTP, HTTPS, TLS1, DNS, SSH, MYSQL, SMTP, RDP, RDPS, VNC, POP3, IMAP4, SMTPS, POP3S, FTPS, ANY, or BGP. |
dst_port |
Integer |
Destination port. |
protocol |
String |
Protocol type: 6 (TCP), 17 (UDP), 1 (ICMP), 58 (ICMPv6), or -1 (any). It cannot be left blank when type is set to 0 (manual), and can be left blank when type is set to 1 (automatic). |
dst_host |
String |
Destination host. |
dst_region_id |
String |
Destination region ID. |
dst_region_name |
String |
Destination region name. |
src_region_id |
String |
Source region ID. |
src_region_name |
String |
Source region name. |
dst_province_id |
String |
Destination province ID. |
dst_province_name |
String |
Destination province name. |
dst_city_id |
String |
Destination city ID. |
dst_city_name |
String |
Destination city name. |
src_province_id |
String |
Source province ID. |
src_province_name |
String |
Source province name. |
src_city_id |
String |
Source city ID. |
src_city_name |
String |
Source city name. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
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
Value returned for flow log query.
{ "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, "src_province_id" : "source province id", "src_province_name" : "source province name", "src_city_id" : "source city id", "src_city_name" : "source city name", "dst_province_id" : "dst province id", "dst_province_name" : "dst province name", "dst_city_id" : "dst city id", "dst_city_name" : "dst city name" } ], "total" : 1 } }
Status code: 400
Bad Request
{ "error_code" : "CFW.00500002", "error_msg" : "Invalid interval." }
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 |
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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("<YOUR REGION>")) .build(); ListFlowLogsRequest request = new ListFlowLogsRequest(); 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 |
# coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListFlowLogsRequest() 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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cfw.NewCfwClient( cfw.CfwClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListFlowLogsRequest{} 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 |
Value returned for flow log query. |
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