调用CreateFlowlog接口创建流日志。

使用说明

流日志可以帮您捕获转发路由器之间的跨地域流量信息和边界路由器VBR(Virtual border router)连接的流量信息,在创建流日志前,请先了解以下说明:

  • 仅企业版转发路由器支持创建流日志。
  • 当前仅部分地域的流日志功能支持捕获VBR连接的流量信息。关于地域的信息,请参见使用限制
  • 对于跨地域连接的流量信息,流日志仅捕获转发路由器出方向的流量信息,不支持捕获转发路由器入方向的流量信息。

    例如,美国(硅谷)地域的云服务器ECS(Elastic Compute Service)实例通过云企业网访问美国(弗吉尼亚)地域的ECS实例,在您为美国(弗吉尼亚)地域的转发路由器配置流日志后,您可以在日志服务控制台查看美国(弗吉尼亚)ECS实例向美国(硅谷)ECS实例发送的报文信息,但无法查看美国(硅谷)ECS实例向美国(弗吉尼亚)ECS实例发送的报文信息。如果您需要查看美国(硅谷)ECS实例向美国(弗吉尼亚)ECS实例发送的报文信息,您需要在美国(硅谷)地域的转发路由器上也配置流日志。

  • CreateFlowlog接口属于异步接口,即系统会先返回一个流日志ID,但是流日志并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeFlowlogs接口查询流日志的状态。
    • 当流日志处于Creating状态时,表示流日志正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当流日志处于Active状态时,表示流日志创建完成。

前提条件

在创建流日志前,请确保您已经创建了跨地域连接或者VBR连接。具体操作,请参见CreateTransitRouterPeerAttachment或者CreateTransitRouterVbrAttachment

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateFlowlog

系统规定参数。取值:CreateFlowlog

ClientToken String 123e4567-e89b-12d3-a456-42665544****

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
RegionId String cn-hangzhou

流日志所属的地域ID。

您可以通过调用DescribeChildInstanceRegions接口获取地域ID。

FlowLogName String myFlowlog

流日志名称。

长度为2~128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以http://https://开头。

Description String myFlowlog

流日志的描述信息。

长度为2~256个字符,必须以字母或中文开头,但不能以http://https://开头。

CenId String cen-7qthudw0ll6jmc****

云企业网实例ID。

ProjectName String FlowLogProject

存储捕获流量的Project。

  • 如果您已经在当前地域创建了Project,您可以输入已创建的Project的名称。
  • 如果您未在当前地域创建Project,您可以为Project自定义名称,系统会帮您自动创建Project。

    Project名称在阿里云地域内全局唯一,创建后不可修改。其命名规则如下:

    • Project名称必须全局唯一。
    • 只能包括小写字母、数字和短划线(-)。
    • 必须以小写字母或者数字开头和结尾。
    • 长度为3~63字符。
LogStoreName String FlowLogStore

存储捕获流量的Logstore。

  • 如果您已经在当前地域创建了Logstore,您可以输入已创建的Logstore的名称。
  • 如果您未在当前地域创建Logstore,您可以为Logstore自定义名称,系统会帮您自动创建Logstore。

    Logstore名称。其命名规则如下:

    • 同一个Project下,Logstore名称不可重复。
    • 只能包括小写字母、数字、短划线(-)和下划线(_)。
    • 必须以小写字母或者数字开头和结尾。
    • 长度为3~63字符。
Interval Long 600

流日志捕获流量的捕获窗口时长。单位:秒。取值:60600。默认值:600

TransitRouterAttachmentId String tr-attach-r6g0m3epjehw57****

跨地域连接ID或者VBR连接ID。

说明 本参数为必填参数。

返回数据

名称 类型 示例值 描述
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B457

请求ID。

Success String true

当前接口调用是否成功。

  • true:成功。
  • false:失败。
FlowLogId String flowlog-m5evbtbpt****

流日志ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateFlowlog
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&RegionId=cn-hangzhou
&FlowLogName=myFlowlog
&Description=myFlowlog
&CenId=cen-7qthudw0ll6jmc****
&ProjectName=FlowLogProject
&LogStoreName=FlowLogStore
&Interval=600
&TransitRouterAttachmentId=tr-attach-r6g0m3epjehw57****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateFlowlogResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
    <Success>true</Success>
    <FlowLogId>flowlog-m5evbtbpt****</FlowLogId>
</CreateFlowlogResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 Flowlog.AlreayExist This attachment already has existed flowlog instance. 该Attachment已经存在相关flowlog

访问错误中心查看更多错误码。