DescribeFlowLogs - Express Connect - Alibaba Cloud Documentation Center

Queries flow logs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

expressconnectrouter:DescribeFlowLogs

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EcrId	string	Yes	The ID of the Express Connect Router (ECR) instance.	ecr-a5xqrgbeidz1w8****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Performs a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned. No service resources are modified. false (default): Sends a normal request. If the request passes the check, a 2xx HTTP status code is returned and the operation is performed.	true
ClientToken	string	No	A client token that you can use to ensure the idempotence of the request. You must use a client token that is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-00****
Tag	array<object>	No	The tags. You can specify up to 20 tags.
	object	No	A list of tags.
Key	string	No	The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters long. It cannot start with aliyun or acs: and cannot contain http:// or https://.	TestKey
Value	string	No	The tag value. The tag value can be an empty string. The tag value can be up to 128 characters long. It cannot start with acs: and cannot contain http:// or https://.	TestValue
NextToken	string	No	The token that is used for the next query. Valid values: If this is your first query or if no next query is to be sent, do not specify this parameter. If a value is returned for NextToken, the value is the token for the next query.	gAAAAABkWw*******
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 2,147,483,647. Default value: 10.	10
FlowLogId	string	No	The ID of the flow log instance.	ecr-flog-jqnr0veifo5d****
FlowLogName	string	No	The name of the flow log. The name can be 0 to 128 characters long.	same-flowlog
ProjectName	string	No	The name of the Log Service project where captured traffic is stored. If you have a project in the current region, enter the project name. If you do not have a project in the current region, enter a custom name. The system automatically creates a project for you. A project name must be globally unique within an Alibaba Cloud region and cannot be modified after it is created. The name must meet the following requirements: The name must be globally unique. The name can contain only lowercase letters, digits, and hyphens (-). The name must start and end with a lowercase letter or a digit. The name must be 3 to 63 characters long. Must be 3 to 63 characters long.	myFlowlog
LogStoreName	string	No	The name of the Logstore where captured traffic is stored. If you have a Logstore in the current region, enter the Logstore name. If you do not have a Logstore in the current region, enter a custom name. The system automatically creates a Logstore for you. The name must meet the following requirements: The name must be unique within a project. The name can contain only lowercase letters, digits, hyphens (-), and underscores (_). The name must start and end with a lowercase letter or a digit. The name must be 3 to 63 characters long.	myFlowlog
InstanceId	string	No	The ID of the virtual border router (VBR) that is associated with the ECR instance.	vbr-j6cwxhgg0s5nuephp****
ResourceGroupId	string	No	The ID of the resource group to which the flow log instance belongs.	rg-aek2aq7f4va****

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	6FABF516-FED3-5697-BDA2-B18C5D9A****
Success	boolean	Indicates whether the request was successful. Valid values: true false	True
Code	string	The response code. A value of 200 indicates that the request was successful. For more information about other values, see the Error codes section of this topic.	200
Message	string	The response message.	OK
HttpStatusCode	integer	The HTTP status code.	200
DynamicCode	string	The dynamic error code.	IllegalParamFormat.EcrId
DynamicMessage	string	The dynamic error message that is used to replace the `%s` placeholder in the error message. Note For example, if the error message is The Value of Input Parameter %s is not valid and the DynamicMessage parameter returns DtsJobId, the specified DtsJobId parameter is invalid.	The param format of EcrId **** is illegal.
AccessDeniedDetail	string	The details of the access denial.	Authentication is failed for ****
TotalCount	integer	The total number of entries that match the query.	11
MaxResults	integer	The number of entries to return on each page. Valid values: 1 to 2,147,483,647. Default value: 10.	10
NextToken	string	The token that is used for the next query. Valid values: If NextToken is empty, no next query is to be sent. If a value is returned for NextToken, the value is the token that is used for the next query.	AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
FlowLogs	array<object>	A list of flow logs.
	object	The details of the flow log.
FlowLogId	string	The ID of the flow log instance.	ecr-flog-leypqehtgtia2*****
EcrId	string	The ID of the ECR instance.	ecr-h4cop1khw98*****
RegionId	string	The region ID of the ECR instance.	cn-shanghai
Status	string	The status of the flow log. Active: The flow log is enabled. Inactive: The flow log is disabled.	Active
FlowLogName	string	The name of the flow log.	myFlowlog
Description	string	The description of the Express Connect Router (ECR) instance.	myFlowlog
Interval	integer	The aggregation interval for the flow log. Unit: seconds. Valid values: 60 600 Default value: 600.	600
SamplingRate	string	The sampling rate. Valid values: 1:4096 1:2048 1:1024 Default value: 1:4096.	1:4096
LogStoreName	string	The name of the Logstore that stores the captured traffic.	FlowLogStore
ProjectName	string	The name of the project that stores the captured traffic.	FlowLogProject
InstanceType	string	The type of the network instance. The value is fixed as VBR, which indicates a virtual border router. VBR: A Virtual Border Router instance.	VBR
ResourceGroupId	string	The ID of the resource group to which the flow log instance belongs.	rg-aekzb3xwrexc4ry
Tags	array<object>	The tags that are added to the Express Connect Router (ECR) instance.
	object	The details of the tag.
Key	string	The tag key. The tag key cannot be an empty string. Note The tag key can be up to 64 characters long. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.	TagKey
Value	string	The tag value. Note The tag value can be up to 128 characters long and cannot start with `acs:`. It cannot contain `http://` or `https://`. The tag value can be an empty string.	TagValue
InstanceId	string	The ID of the VBR instance associated with the flow log.	vbr-9dpty76irpf4u15*****
CreationTime	string	The time when the flow log was created. The time is displayed in the YYYY-MM-DDThh:mm:ssZ format and is in Coordinated Universal Time (UTC).	2023-09-21T04:20Z
SlsRegionId	string	The region ID of Log Service.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "6FABF516-FED3-5697-BDA2-B18C5D9A****",
  "Success": true,
  "Code": "200",
  "Message": "OK",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.EcrId",
  "DynamicMessage": "The param format of EcrId **** is illegal.",
  "AccessDeniedDetail": "Authentication is failed for ****\n",
  "TotalCount": 11,
  "MaxResults": 10,
  "NextToken": "AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****",
  "FlowLogs": [
    {
      "FlowLogId": "ecr-flog-leypqehtgtia2*****",
      "EcrId": "ecr-h4cop1khw98*****",
      "RegionId": "cn-shanghai",
      "Status": "Active",
      "FlowLogName": "myFlowlog",
      "Description": "myFlowlog",
      "Interval": 600,
      "SamplingRate": "1:4096 ",
      "LogStoreName": "FlowLogStore",
      "ProjectName": "FlowLogProject",
      "InstanceType": "VBR",
      "ResourceGroupId": "rg-aekzb3xwrexc4ry",
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ],
      "InstanceId": "vbr-9dpty76irpf4u15*****",
      "CreationTime": "2023-09-21T04:20Z",
      "SlsRegionId": "cn-hangzhou"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.Ecr	Ecr Status does not allow current operation.	The status of the express connect gateway instance does not allow the current operation. Currently, other operations are being performed or the express connect gateway instance is being deleted. Please try again later.
400	OperationDenied.ForceDeleting	The current instance is being deleted.	Your current operation is rejected and the leased line gateway instance is being forcibly deleted. Please try again later.
400	UnsupportedRegion	Feature not supported in specified region.	The specified region does not support the leased line gateway function.
400	IllegalParamFormat.%s	The param format of %s is illegal.	Illegal parameter format

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.