创建流日志。
接口说明
流日志可以帮您捕获转发路由器实例和网络实例连接(跨地域连接、VPC 连接、VPN 连接、ECR 连接和 VBR 连接)传输的流量信息。在创建流日志前,请先了解以下说明:
-
仅企业版转发路由器支持创建流日志。
-
对于跨地域连接的流量信息,流日志仅捕获转发路由器出方向的流量信息,不支持捕获转发路由器入方向的流量信息。
例如,美国(硅谷)地域的云服务器 ECS(Elastic Compute Service)实例通过云企业网访问美国(弗吉尼亚)地域的 ECS 实例,在您为美国(弗吉尼亚)地域的转发路由器配置流日志后,您可以在日志服务控制台查看美国(弗吉尼亚)ECS 实例向美国(硅谷)ECS 实例发送的报文信息,但无法查看美国(硅谷)ECS 实例向美国(弗吉尼亚)ECS 实例发送的报文信息。如果您需要查看美国(硅谷)ECS 实例向美国(弗吉尼亚)ECS 实例发送的报文信息,您需要在美国(硅谷)地域的转发路由器上也配置流日志。
-
流日志捕获 VPC 连接的流量信息时,仅捕获转发路由器 ENI 传输的流量信息,如果您需要了解 VPC 内其他 ENI 传输的流量信息,请参见 VPC 流日志概述。
-
CreateFlowlog
接口属于异步接口,即系统会先返回一个流日志 ID,但是流日志并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeFlowlogs
接口查询流日志的状态。当流日志处于 Creating 状态时,表示流日志正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
当流日志处于 Active 状态时,表示流日志创建完成。
前提条件
为资源创建流日志前,请确保您已经拥有了相关资源。各个资源的创建操作,请参见:
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
cen:CreateFlowlog |
create |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
ClientToken |
string |
否 |
客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。 |
123e4567-e89b-12d3-a456-42665544**** |
RegionId |
string |
是 |
流日志所属的地域 ID。 您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。 |
cn-hangzhou |
FlowLogName |
string |
否 |
流日志名称。 名称可以为空或长度为 1~128 个字符,不能以 http://或 https://开头。 |
myFlowlog |
Description |
string |
否 |
流日志的描述信息。 描述可以为空或长度为 1~256 个字符,不能以 http://或 https://开头。 |
myFlowlog |
CenId |
string |
是 |
云企业网实例 ID。 |
cen-7qthudw0ll6jmc**** |
ProjectName |
string |
否 |
存储捕获流量的 Project。
|
flowlog-project |
LogStoreName |
string |
否 |
存储捕获流量的 Logstore。
|
flowlog-logstore |
Interval |
integer |
否 |
流日志捕获流量的捕获窗口时长。单位:秒。取值:60 或 600。默认值:600。 |
600 |
TransitRouterAttachmentId |
string |
否 |
VPC 连接、VPN 连接、VBR 连接、ECR 连接或跨地域连接 ID。 若需配置转发路由器实例的流日志,此字段不填值。 |
tr-attach-r6g0m3epjehw57**** |
TransitRouterId |
string |
否 |
转发路由器实例 ID。 |
tr-bp1rmwxnk221e3fas**** |
LogFormatString |
string |
否 |
自定义流日志记录字段的字符串。 格式定义为:
|
${srcaddr}${dstaddr}${bytes} |
Tag |
array<object> |
否 |
标签信息。 一次最多支持输入 20 个标签信息。 |
|
object |
否 |
标签信息。 一次最多支持输入 20 个标签信息。 |
||
Key |
string |
否 |
资源的标签键。 一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以 一次最多支持输入 20 个标签的标签键。 |
TagKey |
Value |
string |
否 |
资源的标签值。 标签值可以为空或输入不超过 128 个字符的字符串,不能以 每一个标签键对应一个标签值,一次最多支持输入 20 个标签键对应的标签值。 |
TagValue |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回结果。 |
||
RequestId |
string |
请求 ID。 |
54B48E3D-DF70-471B-AA93-08E683A1B457 |
Success |
string |
当前接口调用是否成功。
|
true |
FlowLogId |
string |
流日志 ID。 |
flowlog-m5evbtbpt**** |
示例
正常返回示例
JSON
格式
{
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
"Success": "true",
"FlowLogId": "flowlog-m5evbtbpt****"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | ProjectOrLogstoreNotExist | The specified project or logstore does not exist. | 参数中指定的project或logstore不存在。 |
400 | SourceProjectNotExist | The Source Project or logstore does not exist. | SourceProject或者logstore不存在。 |
400 | OperationUnsupported.action | This action is not support. | 当前地域不支持该操作。 |
400 | RuleExist | The rule has already existed. | 该规则已存在。 |
400 | QuotaExceeded.FlowlogCount | This user has reached the maximum instance number of flowlog. | flowlog数量已达到上限。 |
400 | InvalidFlowlogId.exist | This cenId already has flowlog instance existed. | 当前Cen已经存在flowlog,无法操作。 |
400 | Flowlog.AlreayExist | This attachment already has existed flowlog instance. | flowlog已存在,无法重复创建。 |
400 | IllegalParam.TransitRouterAttachmentId | TransitRouterAttachmentId is illegal. | 参数中指定的TrInstance不合法。 |
400 | InvalidTransitRouterAttachmentId.NotFound | The TransitRouterAttachmentId is not found. | 参数中指定的TransitRouterAttachmentId不存在。 |
400 | IncorrectStatus.flowlog | This action is not allowed in the current flow log status. | flowlog状态不正确 |
400 | InvalidOperation.TransitRouterNotExist | Operation is invalid because the transit router not exist. | 转发路由器不存在。 |
400 | IncorrectStatus.TransitRouterAttachmentId | The resource is not in a valid state for the attachment operation. | 当前该Attachment不处于稳态,不支持该操作。 |
400 | ProjectExist | Project already exist, please try a different project name. | 日志Project已存在,请尝试使用不同的Project名称。 |
400 | InvalidParameter.ProjectName | Project name is invalid or does not belong to specified region. | Project名称不合法或与不属于指定的region。 |
400 | IncorrectStatus.TrFlowlog | Flowlog status for specified TransitRouter is invalid for this operation. | 指定转发路由器的流日志配置状态不合法。 |
400 | OperationInvalid.IncompatibleFlowlogExist | Operation is invalid because incompatible flowlog config exists. | 存在不兼容的Flowlog配置,请删除后重试。 |
400 | InvalidParameter.LogFormatString | LogFormatString is invalid. | 指定的日志格式不合法。 |
400 | InvalidParameter.LogStoreName | Specified LogStore name is invalid. | Logstore名称不合法。 |
400 | OperationFailed.InvalidLogInfo | The entered log service information is invalid. Check whether the ProjectName and LogStoreName are correct, and whether Log Service has been activated. | 输入的日志服务信息不合法。请确认ProjectName以及LogStoreName是否正确,并确认是否已开通日志服务。 |
400 | IncorrectStatus.TransitRouterInstance | The status of TransitRouter is incorrect. | 转发路由器状态不正确。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
400 | InvalidParameter.CenId | The specified parameter CenId is invalid. | |
403 | NoPermission.AliyunServiceRoleForTRFlowLog | You are not authorized to create service linked role AliyunServiceRoleForTRFlowLog. | 无权限创建服务关联角色AliyunServiceRoleForTRFlowLog。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。