CreateFlowLog--私有网络-火山引擎

文档中心

立即注册

导航

CreateFlowLog

最近更新时间：2024.09.06 08:11:09首次发布时间：2024.01.09 07:24:42

调用 CreateFlowLog 接口，创建流日志。

调用说明

单用户单region支持创建的VPC流日志数量10个。
CreateFlowLog 为异步接口，即返回请求ID时，系统后台仍在创建。您可调用 DescribeFlowLogs 查看流日志的状态，Creating表示创建中，Active 表示创建完成。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	CreateFlowLog	要执行的操作，取值为CreateFlowLog。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
FlowLogName	String	是	FlowLog-1	流日志的名称。长度限制为1 ~ 128个字符。需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。不填默认为流日志实例的ID。
Description	String	否	FlowLog_VPC	流日志的描述信息。长度限制为0~ 255个字符。不填默认为空字符串。需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
ResourceType	String	是	vpc	要采集流量的资源类型，取值如下： vpc：私有网络。 subnet：子网。 eni：网卡。
ResourceId	String	是	vpc-123456****	要采集流量的资源ID。根据`ResourceType`传入的参数，传入对应类型资源的ID。
TrafficType	String	是	All	采集的流量类型。取值如下： All：全部流量。 Allow：网络ACL和安全组允许的流量。 Drop：网络ACL和安全组拒绝的流量
LogProjectName	String	是	flowlog-project-1	流日志项目的名称。名称只能由小写字母、数字和连字符（-）组成。必须以小写字母或者数字开头和结尾。名称的长度范围为 3~63 个字符。说明根据名称匹配是否有日志项目，若没有，则新建日志项目。
LogTopicName	String	是	flowlog-topic-1	流日志主题的名称。需要满足以下要求。只支持小写英文字母、数字和连字符（-）。必须以小写英文字母或数字开头或结尾。长度为 3～63 个字符。说明根据名称匹配是否为`LogTopicName`传入的项目，若不是，则新建日志主题。
AggregationInterval	Integer	否	10	流日志的采样间隔。取值如下 1：1分钟。 5：5分钟。 10（默认值）：10分钟。
ProjectName	String	否	default	流日志所属项目的名称。不填默认加入default项目。
Tags.N.Key	String	否	Tags.1.Key=key1&Tags.2.Key=key2	用户标签的标签键。参数 - N：表示标签键的序号，取值范围：1～50。多个标签键之间用&分隔。不能以 `volc:`或`sys:`开头，包括任意大小写形式。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。说明同一资源的标签键不允许重复。
Tags.N.Value	String	否	Tags.1.Value=value1&Tags.2.Value=value2	用户标签的标签值。参数 - N：表示标签值的序号，取值范围：1～50。多个标签值之间用&分隔。长度取值范围为0～256字符，不填默认为空。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。说明若传入该参数，则必须先传入`Tags.N.Key`。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	客户端Token，用于保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。仅支持ASCII字符，且不能超过64个字符。若不传入ClientToken，则此次API调用不进行幂等校验。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
FlowLogId	String	fl-123456****	流日志ID。

请求示例

GET /?Action=CreateFlowLog&Version=2020-04-01&FlowLogName=FlowLog-1&Description=FlowLog_VPC&ResourceType=vpc&ResourceId=vpc-123456****&TrafficType=All&LogProjectName=flowlog-project-1&LogTopicName=flowlog-topic-1&AggregationInterval=10 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "CreateFlowLog",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "FlowLogId": "2021062415303301022514515207C4****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
400	InvalidDescription.Malformed	The specified description is malformed.	指定的描述格式不合法。请修复描述格式后重试。
400	InvalidDescription.Malformed	The specified description is malformed. Ensure the maximum length of description is 255.	指定的描述格式不合法。描述长度不能超过255个字符。
400	InvalidEni.InvalidStatus	The specified elastic network interface is not in the correct status for the request.	指定的弹性网卡所处的状态无法响应该请求。
400	InvalidFlowLog.CloudProfileNotAvailable	The cloud profile is not available in this region.	当前地域账号系统暂不可用。
400	InvalidFlowLog.TlsNotSupport	The specified account is not supported by TLS service in this region.	当前账号在此地域不支持TLS服务。
400	InvalidName.Malformed	The specified name is malformed. Ensure the maximum length of name is 128.	指定的名称格式不合法。名称长度不能超过128个字符。
400	InvalidName.Malformed	The specified name is malformed.	指定的名称格式不合法。请修复名称格式后重试。
400	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400	InvalidParameter.FlowLogAggregationInterval	The specified aggregation interval is invalid.	指定的流日志采样间隔参数不合法。
400	InvalidParameter.FlowLogInvalidResource	The specified resource is not allowed to be bound to a flow log.	指定的资源由于类型限制无法绑定流日志。
400	InvalidParameter.FlowLogResourceAlreadyBound	The specified resource is already bound to a flow log.	指定的资源已绑定流日志。
400	InvalidParameter.FlowLogTrafficType	The specified traffic type is invalid.	指定的采集流量类型参数不合法。
400	InvalidParameter.TLSTopicExisted	The specified topic name already exists.	指定的日志主题名称已存在，无法新建。
400	InvalidResourceType.Malformed	The specified parameter resource type is invalid.	资源类型不合法。
400	InvalidSubnet.InvalidStatus	The specified subnet is not in the correct status for the request.	指定的子网所处的状态无法响应该请求。
400	InvalidTag.Disorder	The specified index order of tag is malformed.	指定标签的索引顺序参数格式不合法。
400	InvalidTagKey.Malformed	The specified parameter tag key is invalid.	标签键不合法。
400	InvalidTagValue.Malformed	The specified parameter tag value is invalid.	标签值不合法。
400	InvalidVpc.InvalidStatus	The specified VPC is not in the correct status for the request.	指定的VPC所处状态无法响应该请求。
400	LimitExceeded.TLSProject	You've reached the limit on the number of TLS project per region that you can create.	已达到当前账户在单一地域下可创建的TLS日志项目数量上限。
400	LimitExceeded.TLSTopic	You've reached the limit on the number of TLS topics per project that you can create.	已达到当前账户在单个TLS日志项目下可创建的TLS日志主题数量上限。
400	LimitExceeded.Tags	You've reached the limit on the number of tags that you can operate at one time.	已达到单次可操作标签数量的上限。
400	OrderError	Failed to create an order in one step.	创建订单并支付失败。
400	UnsupportedOperation	The request on the specified instance is denied due to the account balance and available vouchers are less than 100 yuan in total.	因账户余额及可用代金券共不足100元，对于该实例的操作请求被拒绝。
400	UnsupportedOperation	The request on the specified instance is denied due to the account in arrears status.	因账户处于欠费状态，对于该实例的操作请求被拒绝。
401	InvalidOperation.NoPermission	The current service is not allowed to do this operation.	当前服务未被授权。
403	Forbidden.PurchaseLimited	The account is not authorized to purchase the resource.	此账户无权限购买资源。
403	Forbidden.ShareENI	You are not authorized to perform operations on the specified elastic network interface. The specified elastic network interface in shared subnet does not support this operation.	无权限对指定弹性网卡进行操作。在共享子网中的指定弹性网卡不支持此操作。
403	InvalidFlowLog.TlsAccessDenied	TLS service access denied.	当前账号未开通日志服务。
404	InvalidProject.NotFound	The specified Project does not exist.	指定的项目不存在。
404	InvalidResource.NotFound	The specified resource does not exist.	指定的资源不存在。
409	InvalidOperation.Conflict	The specified resource operation conflicts.	指定的资源操作冲突。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。