All Products
Search

This Product

    Cloud Enterprise Network:CreateFlowlog

    Document Center

    Cloud Enterprise Network:CreateFlowlog

    Last Updated:Nov 29, 2024

    Creates a flow log.

    Operation description

    Flow logs can be used to capture traffic information about transit routers and network instance connections, including inter-region connections, virtual private cloud (VPC) connections, VPN connections, Express Connect Router (ECR) connections, and virtual border router (VBR) connections. Before you create a flow log, take note of the following items:

    • Flow logs are supported only by Enterprise Edition transit routers.

    • Flow logs are used to capture information about outbound traffic on transit routers. Information about inbound traffic on transit routers is not captured.

      For example, an Elastic Compute Service (ECS) instance in the US (Silicon Valley) region accesses an ECS instance in the US (Virginia) region through Cloud Enterprise Network (CEN). After you enable the flow log feature for the transit router in the US (Virginia) region, you can check the log entries about packets sent from the ECS instance in the US (Virginia) region to the ECS instance in the US (Silicon Valley) region. However, packets sent from the ECS instance in the US (Silicon Valley) region to the ECS instance in the US (Virginia) region are not recorded. If you want to record the packets sent from the ECS instance in the US (Silicon Valley) region to the ECS instance in the US (Virginia) region, you must also enable the flow log feature on the transit router that is in the US (Silicon Valley) region.

    • If you use a flow log to capture traffic information about VPC connections, the flow log captures information only about traffic on the elastic network interface (ENI) of the transit router. For more information about how to view traffic information about other ENIs in the VPC, see VPC flow log overview.

    • CreateFlowLog is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeFlowlogs operation to query the status of a flow log.

      • If the flow log is in the Creating state, the flow log is being created. In this case, you can query the flow log but cannot perform other operations.
      • If the flow log is in the Active state, the flow log is created.

    Prerequisites

    Required resources are created. For more information about how to create resources, see the following topics:

    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.

    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:
      • The required resource types are displayed in bold characters.
      • 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    cen:CreateFlowlogcreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request.

    You can use the client to generate the value, but you must make sure that it is unique among all requests. The token can contain only ASCII characters.

    Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
    		123e4567-e89b-12d3-a456-42665544****
    RegionIdstringYes

    The ID of the region where the flow log is deployed.

    You can call the DescribeChildInstanceRegions operation to query the most recent region list.

    		cn-hangzhou
    FlowLogNamestringNo

    The flow log name.

    The name can be empty or 1 to 128 characters in length, and cannot start with http:// or https://.

    		myFlowlog
    DescriptionstringNo

    The description of the flow log.

    The description is optional. If you enter a description, it must be 1 to 256 characters in length, and cannot start with http:// or https://.

    		myFlowlog
    CenIdstringYes

    The ID of the CEN instance.

    		cen-7qthudw0ll6jmc****
    ProjectNamestringYes

    The project that stores the captured traffic data.

    • If a project is already created in the selected region, enter the name of the project.

    • If no projects are created in the selected region, enter a name and the system automatically creates a project.

      The project name must be unique in a region. You cannot change the name after the project 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 in length,
    		FlowLogProject
    LogStoreNamestringYes

    The Logstore that stores the captured traffic data.

    • If a Logstore is already created in the selected region, enter the name of the Logstore.

    • If no Logstores are created in the selected region, enter a name and the system automatically creates a Logstore. The name of the Logstore. The name must meet the following requirements:

      • The name must be unique in 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 in length,
    		FlowLogStore
    IntervallongNo

    The time window for collecting log data. Unit: seconds. Valid values: 60 and 600. Default value: 600.

    		600
    TransitRouterAttachmentIdstringNo

    The ID of the VPC connection, VPN connection, VBR connection, ECR connection, or inter-region connection.

    If you create the flow log for a transfer router, skip this parameter.

    		tr-attach-r6g0m3epjehw57****
    TransitRouterIdstringNo

    The ID of the transit router.

    		tr-bp1rmwxnk221e3fas****
    LogFormatStringstringNo

    The strings that define the fields in the flow log.

    Format: ${Field 1}${Field 2}${Field 3}...{Field n}

    • If you do not configure this parameter, all fields are included in the flow log.
    • If you configure this parameter, start the string with ${srcaddr}${dstaddr}${bytes} because ${srcaddr}${dstaddr}${bytes} are required variables. For more information about the fields supported by flow logs, see Configure a flow log.
    		${srcaddr}${dstaddr}${bytes}
    Tagarray<object>No

    The tags.

    You can specify at most 20 tags.

    objectNo

    The tags.

    You can specify at most 20 tags.

    KeystringNo

    The tag keys.

    The tag keys cannot be an empty string. The tag keys can be up to 64 characters in length. The tag keys cannot start with aliyun or acs: and cannot contain http:// or https://.

    You can specify at most 20 tag keys in each call.

    		TagKey
    ValuestringNo

    The tag values.

    The tag values can be an empty string or up to 128 characters in length. The tag values cannot start with aliyun or acs: and cannot contain http:// or https://.

    Each key-value must be unique. You can specify at most 20 tag values in each call.

    		TagValue

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

    		54B48E3D-DF70-471B-AA93-08E683A1B457
    Successstring

    Indicates whether the call is successful. Valid values:

    • true: yes
    • false: no
    		true
    FlowLogIdstring

    The ID of the flow log.

    		flowlog-m5evbtbpt****

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "Success": "true",
  "FlowLogId": "flowlog-m5evbtbpt****"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ProjectOrLogstoreNotExistThe specified project or logstore does not exist.The error message returned because the specified project or Logstore does not exist.
    400SourceProjectNotExistThe Source Project or logstore does not exist.The error message returned because the specified source project or Logstore does not exist.
    400OperationUnsupported.actionThis action is not support.The error message returned because this operation is not supported in the specified region.
    400RuleExistThe rule has already existed.The rule already exists.
    400QuotaExceeded.FlowlogCountThis user has reached the maximum instance number of flowlog.The error message returned because the number of flow logs has reached the upper limit.
    400InvalidFlowlogId.existThis cenId already has flowlog instance existed.The error message returned because the specified CEN instance is already associated with a flow log.
    400Flowlog.AlreayExistThis attachment already has existed flowlog instance.The error message returned because the specified flow log already exists. You cannot create duplicate flow logs.
    400IllegalParam.TransitRouterAttachmentIdTransitRouterAttachmentId is illegal.The error message returned because the specified transit router is invalid.
    400InvalidTransitRouterAttachmentId.NotFoundThe TransitRouterAttachmentId is not found.The error message returned because the specified transit router attachment ID (TransitRouterAttachmentId) does not exist.
    400IncorrectStatus.flowlogThis action is not allowed in the current flow log status.This action is not allowed in the current flow log status.
    400InvalidOperation.TransitRouterNotExistOperation is invalid because the transit router not exist.The error message returned because the specified transit router does not exist.
    400IncorrectStatus.TransitRouterAttachmentIdThe resource is not in a valid state for the attachment operation.The error message returned because the operation is not supported when the specified attachment is in an unstable state
    400ProjectExistProject already exist, please try a different project name.The log Project already exists, try a different Project name.
    400InvalidParameter.ProjectNameProject name is invalid or does not belong to specified region.The Project name is illegal or does not belong to the specified region.
    400IncorrectStatus.TrFlowlogFlowlog status for specified TransitRouter is invalid for this operation.Flowlog status for specified TransitRouter is invalid for this operation.
    400OperationInvalid.IncompatibleFlowlogExistOperation is invalid because incompatible flowlog config exists.There are incompatible Flowlog configurations, please delete and try again.
    400InvalidParameter.LogFormatStringLogFormatString is invalid.The specified log format is invalid.
    400InvalidParameter.LogStoreNameSpecified LogStore name is invalid.Logstore name is invalid.
    400InvalidParameter.ProjectNameProjectName is invalid.Project name is invalid.
    400OperationFailed.InvalidLogInfoThe entered log service information is invalid. Check whether the ProjectName and LogStoreName are correct, and whether Log Service has been activated.The entered log service information is invalid. Check whether the ProjectName and LogStoreName are correct, and whether Log Service has been activated.
    400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
    400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.
    403NoPermission.AliyunServiceRoleForTRFlowLogYou are not authorized to create service linked role AliyunServiceRoleForTRFlowLog.You are not authorized to create service linked role AliyunServiceRoleForTRFlowLog.

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

    Change history

    Change timeSummary of changesOperation
    2024-11-22API Description Update. The Error code has changedView Change Details
    2024-11-14The Error code has changed. The request parameters of the API has changedView Change Details
    2024-07-02The Error code has changedView Change Details
    2024-05-22The Error code has changedView Change Details
    2023-01-03The Error code has changedView Change Details