DescribeFlowLogs - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries flow logs in a specified region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DescribeFlowLogs	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region that the flow logs are stored.	cn-shanghai
FlowLogId	string	No	The ID of a flow log.	fl-7a56mar1kfw9vj****
FlowLogName	string	No	The name of the flow log.	DDE
Description	string	No	The description of the flow log.	desc
Status	string	No	The status of the flow log. Valid values: Active: The flow log is enabled. Inactive: The flow log is disabled.	Active
OutputType	string	No	The location where the flow log is stored. Valid values: sls: The flow log is stored in Log Service. netflow: The flow log is stored on a NetFlow collector. all: The flow log is stored both in Log Service and on a NetFlow collector.	all
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of flow logs.	5
FlowLogs	array<object>	The list of flow logs.
FlowLogSetType	object
Status	string	The status of the flow log. Valid values: Active: The flow log is enabled. Inactive: The flow log is disabled.	Active
TotalSagNum	integer	The number of Smart Access gateway (SAG) instances with which the flow log is associated.	2
NetflowServerIp	string	The address of the NetFlow collector where the flow log is stored.	192.168.0.1
ProjectName	string	The name of the Log Service project.	sag-flowlog-shanghai
SlsRegionId	string	The ID of the region that the Log Service is deployed.	cn-shanghai
ActiveAging	integer	The output interval under active connections. Unit: seconds.	300
OutputType	string	The location where the flow log is stored. Valid values: sls: The flow log is stored in Log Service. netflow: The flow log is stored on a NetFlow collector. all: The flow log is stored both in Log Service and on a NetFlow collector.	sls
Description	string	The description of the flow log.	aaa
NetflowVersion	string	The protocol version number of the NetFlow collector that stores the flow log. Default value: V9.	V9
InactiveAging	integer	The output interval under inactive connections. Unit: seconds.	15
NetflowServerPort	string	The port number of the NetFlow collector that stores the flow log. Default value: 9995.	9995
Name	string	The name of the flow log.	DDE
FlowLogId	string	The ID of the flow log.	fl-7a56mar1kfw9vj****
LogstoreName	string	The name of the Logstore in Log Service.	config-operation-log
ResourceGroupId	string	The ID of the resource group to which the flow log belongs.	rg-acfm2iu4fnc****
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	44F4E2D0-77F7-4DEC-969B-061688946143
PageNumber	integer	The page number of the returned page.	1

Examples

Sample success responses

JSONformat

{
  "TotalCount": 5,
  "FlowLogs": {
    "FlowLogSetType": [
      {
        "Status": "Active",
        "TotalSagNum": 2,
        "NetflowServerIp": "192.168.0.1",
        "ProjectName": "sag-flowlog-shanghai",
        "SlsRegionId": "cn-shanghai",
        "ActiveAging": 300,
        "OutputType": "sls",
        "Description": "aaa",
        "NetflowVersion": "V9",
        "InactiveAging": 15,
        "NetflowServerPort": 9995,
        "Name": "DDE",
        "FlowLogId": "fl-7a56mar1kfw9vj****",
        "LogstoreName": "config-operation-log",
        "ResourceGroupId": "rg-acfm2iu4fnc****"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "44F4E2D0-77F7-4DEC-969B-061688946143",
  "PageNumber": 1
}

Error codes

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