Enable a Flow Log with ActiveFlowLog API - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Activates a flow log to start capturing traffic of specified resources.

Operation description

After a flow log is created, it is in the Active state by default. If you stopped a flow log, you can call this operation to reactivate it.
ActiveFlowLog is an asynchronous operation. After you send a request, the system returns a RequestId, but activate flow log is not fully activated. The activation task is still running in the background. You can call the DescribeFlowlogs operation to query the status of activate flow log.
- If activate flow log is in the Modifying state, activate flow log is being activated. In this state, you can only perform query operations.
- If activate flow log is in the Active state, activate flow log is activated.

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

cen:ActiveFlowLog

update

*Flowlog

acs:cbn:{#regionId}:{#accountId}:flowlog/{#flowlogId}

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-42665544****
RegionId	string	Yes	The region ID of the flow log. You can call the DescribeChildInstanceRegions operation to query the region ID.	cn-hangzhou
FlowLogId	string	Yes	The flow log ID.	flowlog-m5evbtbpt****
CenId	string	No	The Cloud Enterprise Network (CEN) instance ID.	cen-7qthudw0ll6jmc****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Success	string	Indicates whether the call is successful. true: successful. false: failed.	true
RequestId	string	The request ID.	F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1

Examples

Success response

JSON format

{
  "Success": "true",
  "RequestId": "F7DDDC17-FA06-4AC2-8F35-59D2470FCFC1"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ProjectOrLogstoreNotExist	The specified project or logstore does not exist.	The error message returned because the specified project or Logstore does not exist.
400	SourceProjectNotExist	The Source Project or logstore does not exist.	The error message returned because the specified source project or Logstore does not exist.
400	OperationUnsupported.action	This action is not support.	The error message returned because this operation is not supported in the specified region.
400	RuleExist	The rule has already existed.	The rule already exists.
400	QuotaExceeded.FlowlogCount	This user has reached the maximum instance number of flowlog.	The error message returned because the number of flow logs has reached the upper limit.
400	InvalidFlowlogId.exist	This cenId already has flowlog instance existed.	The error message returned because the specified CEN instance is already associated with a flow log.
400	InvalidFlowlogId.NotFound	The specified flowlog id does not exist or does not match the cen Id.	The error message returned because the specified flow log does not exist.
400	IncorrectStatus.flowlog	Invalid flowlog status.	The error message returned because the status of the flow log does not support this operation. Try again later.
400	IncorrectStatus.TrFlowlog	Flowlog status for specified TransitRouter is invalid for this operation.	Flowlog status for specified TransitRouter is invalid for this operation.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.
400	InvalidParameter.FlowLogId	The specified parameter FlowLogId is invalid.
400	InvalidParameter.CenId	The specified parameter CenId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.