调用CreateFlowLog接口创建流日志。

使用说明

CreateFlowLog接口属于异步接口,即系统会返回一个实例ID,但该流日志尚未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeFlowLogs查询流日志的创建状态:

  • 当流日志处于Activating状态时,表示流日志正在创建中。
  • 当流日志处于Active状态时,表示流日志创建并启动完成。

调试

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

请求参数

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

系统规定参数。取值:CreateFlowLog

RegionId String cn-qingdao

流日志所属的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

FlowLogName String myFlowlog

流日志名称。

名称长度为1~128个字符,不能以http://https://开头。

Description String This is my Flowlog.

流日志描述。

描述长度为1~256个字符,不能以http://https://开头。

ResourceType String NetworkInterface

要捕获流量的资源类型。取值:

  • NetworkInterface:弹性网卡。
  • VSwitch:交换机内的所有弹性网卡。
  • VPC:专有网络内的所有弹性网卡。
ResourceId String eni-askldfas****

要捕获流量的资源ID。

TrafficType String All

采集的流量类型。取值:

  • All:全部流量。
  • Allow:访问控制允许的流量。
  • Drop:访问控制拒绝的流量。
ProjectName String FlowLogProject

管理捕获到的流量的Project名称。

  • Projec名称仅支持小写字母、数字和短划线(-)。
  • 名称的开头与结尾必须为小写字母或数字。
  • 名称长度为3~63个字符。
LogStoreName String FlowLogStore

存储捕获到的流量的LogStore名称。

  • LogStore名称仅支持小写字母、数字、短划线(-)和下划线(_)。
  • 名称的开头与结尾必须为小写字母或数字。
  • 名称长度为3~63个字符。
AggregationInterval Integer 10

流日志的采样间隔。单位:秒。取值:1510(默认值)。

TrafficPath.N String all

采集的流量路径。取值:

  • all(默认值):表示全量采集。
  • internetGateway:表示公网流量采集。
说明 流量路径功能默认不开放,如需使用,请提交工单申请。

返回数据

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

请求ID。

Success String true

是否调用成功。取值:

  • true:调用成功。
  • false:调用失败。
FlowLogId String fl-m5e8vhz2t21sel1nq****

流日志ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateFlowLog
&RegionId=cn-qingdao
&FlowLogName=myFlowlog
&Description=This is my Flowlog.
&ResourceType=NetworkInterface
&ResourceId=eni-askldfas****
&TrafficType=All
&ProjectName=FlowLogProject
&LogStoreName=FlowLogStore
&AggregationInterval=10
&TrafficPath=["all"]
&公共请求参数

正常返回示例

XML格式

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

<CreateFlowLogResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
    <Success>true</Success>
    <FlowLogId>fl-m5e8vhz2t21sel1nq****</FlowLogId>
</CreateFlowLogResponse>

JSON格式

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

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

错误码

HttpCode 错误码 错误信息 描述
400 OperationUnsupported.AdvancedFeature Advanced features of the vpc is unsupported. 不支持该高级特性。
400 InvalidResourceId.NotFound This resourceId already has flowlog instance existed. 要指定的资源已经存在flowlog实例
400 INVALID_PARAMETER The parameter invalid. 参数不合法。
400 MissingParameter Missing mandatory parameter 缺少必要参数,请您检查必填参数是否都已填后再进行操作。
400 IllegalParam.AggregationInterval The param of aggregationInterval is illegal. 采样间隔参数输入不合法
400 UnsupportedFeature.UserDefinedTrafficPath The feature of UserDefinedTrafficPath is not supported. 本用户暂不支持自定义流日志trafficPath功能。
400 IllegalParam.TrafficPath The param of trafficPath is illegal. 传入的trafficPath参数非法。
400 DuplicatedParam.TrafficPath The param of trafficPath is duplicated. 传入的trafficPath参数中存在重复的数值。

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