Querying Details About a Flow Log
Function
This API is used to query the details about a flow log.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
|
Action |
Access Level |
Resource Type (*: required) |
Condition Key |
Alias |
Dependencies |
|---|---|---|---|---|---|
|
er:flowLogs:get |
Read |
flowFlogs * |
- |
- |
- |
URI
GET /v3/{project_id}/enterprise-router/{er_id}/flow-logs/{flow_log_id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
|
er_id |
Yes |
String |
Enterprise router ID |
|
flow_log_id |
Yes |
String |
Flow log ID |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
flow_log |
FlowLog object |
Flow log details |
|
request_id |
String |
Request ID |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Flow log ID |
|
name |
String |
Flow log name |
|
description |
String |
Flow log description |
|
project_id |
String |
Project ID of the flow log task creator |
|
resource_type |
String |
|
|
resource_id |
String |
Resource ID |
|
log_group_id |
String |
Log group ID |
|
log_stream_id |
String |
Log stream ID |
|
log_store_type |
String |
Flow log storage type. |
|
log_aggregation_interval |
Integer |
Log aggregation time, in seconds. The value ranges from 60 to 600. |
|
created_at |
String |
Creation time in the format of YYYY-MM-DDTHH:mm:ss.sssZ |
|
updated_at |
String |
Update time in the format of YYYY-MM-DDTHH:mm:ss.sssZ |
|
state |
String |
|
|
enabled |
Boolean |
Example Requests
Querying flow logs
GET https://{erouter_endpoint}/v3/0605767a9980d5762fbcc00b3537e757/enterprise-router/a43c55e9-4911-4030-90e1-5c2bf6ae6fe2/flow-logs/b216bc1d-5963-41a7-89f9-779a5128c5ac
Example Responses
Status code: 200
OK
{
"flow_log" : {
"id" : "b216bc1d-5963-41a7-89f9-779a5128c5ac",
"name" : "flow_log",
"project_id" : "0605767a9980d5762fbcc00b3537e757",
"resource_type" : "attachment",
"resource_id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
"log_group_id" : "0139393c-eeb2-49f0-bbd4-c5faec6b1497",
"log_stream_id" : "d22c3b44-2f71-470f-83f3-96a8af6956ad",
"log_store_type" : "LTS",
"log_aggregation_interval" : 600,
"created_at" : "2020-03-11T15:13:31Z",
"updated_at" : "2022-03-11T15:13:31Z",
"state" : "available",
"enabled" : true,
"description" : "Flow log"
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
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.