tencent cloud

Feedback

CreateFlowLog

Last updated: 2022-05-31 16:38:06

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to create a flow log.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateFlowLog.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
FlowLogName Yes String The name of the flow log instance.
ResourceType Yes String The type of resource associated with the flow log. Valid values: VPC, SUBNET, NETWORKINTERFACE, CCN, NAT, and DCG.
ResourceId Yes String The unique ID of the resource.
TrafficType Yes String Type of the flow logs to be collected. Valid values: ACCEPT, REJECT and ALL.
VpcId No String The VPC ID or unique ID of the resource. We recommend using the unique ID. This parameter is required unless the ResourceType is set to CCN.
FlowLogDescription No String The description of the flow log instance
CloudLogId No String The storage ID of the flow log.
Tags.N No Array of Tag Bound tags, such as [{"Key": "city", "Value": "shanghai"}]
StorageType No String Consumer types: cls and ckafka
FlowLogStorage No FlowLogStorage Information of the flow log consumer, which is required when the consumer type is ckafka.

3. Output Parameters

Parameter Name Type Description
FlowLog Array of FlowLog The information of the flow log created.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a flow log

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateFlowLog
&CloudLogId=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
&FlowLogDescription=test-flowlog
&FlowLogName=test
&ResourceId=eni-xxxxxxxx
&ResourceType=NETWORKINTERFACE
&TrafficType=ACCEPT
&VpcId=vpc-xxxxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "FlowLog": [
      {
        "VpcId": "vpc-pq9vxykj",
        "FlowLogId": "fl-f42uhpkj",
        "FlowLogName": "test",
        "ResourceType": "NETWORKINTERFACE",
        "ResourceId": "eni-78ysaex1",
        "TrafficType": "ACCEPT",
        "CloudLogId": "dfb8f1a2-8522-47c1-8571-67905167ab3f",
        "CloudLogState": "",
        "FlowLogDescription": "",
        "Enable": true,
        "StorageType": "cls",
        "TagSet": [
          {
            "Key": "city",
            "Value": "shanghai"
          }
        ],
        "FlowLogStorage": {
          "StorageTopic": "",
          "StorageId": ""
        },
        "CreatedTime": "0000-00-00 00:00:00"
      }
    ],
    "RequestId": "404428db-f850-40c2-803"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.CreateCkafkaRouteError Failed to create the Ckafka route. Please retry later.
InvalidParameterValue.Duplicate The input parameter already exists.
InvalidParameterValue.Empty Missing parameters.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.Range The parameter value is not in the specified range.
LimitExceeded Quota limit is reached.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation.FlowLogsNotSupportKoInstanceEni Unable to create a flow log: the current ENI is bound with a KO model.
UnsupportedOperation.FlowLogsNotSupportNullInstanceEni Unable to create a flow log: the current ENI is not bound to an instance.
UnsupportedOperation.OnlySupportProfessionKafka Only the Ckafka Pro Edition is supported.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support