tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Virtual Private Cloud
    Documentation
    Download PDF

    CreateFlowLog

    Last updated: 2023-08-23 14:11:31
    Download PDF

    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 No String Common Params. This parameter is not required for this API.
    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.
    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.
    CloudLogRegion No String The region corresponding to the flow log storage ID. If not passed in, this field defaults to the current region.

    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

    This example shows you how to create a flow log.

    Input Example

    POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowLog
<Common request parameters>

{
    "FlowLogName": "test",
    "CloudLogId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "VpcId": "vpc-xxxxxx",
    "FlowLogDescription": "test-flowlog",
    "ResourceType": "NETWORKINTERFACE",
    "ResourceId": "eni-xxxxxxxx",
    "TrafficType": "ACCEPT"
}

    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": "",
                "CloudLogRegion": "",
                "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.
    InternalError.ModuleError Internal module error
    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.
    InvalidParameterValue.TagDuplicateKey Duplicate tag keys.
    InvalidParameterValue.TagDuplicateResourceType Duplicate tag resource type.
    InvalidParameterValue.TagInvalidKey Invalid tag key.
    InvalidParameterValue.TagInvalidKeyLen Invalid tag key length.
    InvalidParameterValue.TagInvalidVal Invalid tag key.
    InvalidParameterValue.TagKeyNotExists The tag key does not exist.
    InvalidParameterValue.TagNotAllocatedQuota Tags are not assigned quotas.
    InvalidParameterValue.TagNotExisted The tag and value do not exist.
    InvalidParameterValue.TagNotSupportTag Unsupported tag.
    InvalidParameterValue.TagResourceFormatError 'The tag resource format error.
    InvalidParameterValue.TagTimestampExceeded Exceeded the quota of tag timestamp.
    InvalidParameterValue.TagValNotExists The tag value does not exist.
    LimitExceeded Quota limit is reached.
    LimitExceeded.TagKeyExceeded Reached the upper limit of tag keys.
    LimitExceeded.TagKeyPerResourceExceeded Reached the upper limit of tags keys per resource.
    LimitExceeded.TagNotEnoughQuota Insufficient tag quota.
    LimitExceeded.TagQuota Exceeded the tag quota. Unable to create resources.
    LimitExceeded.TagQuotaExceeded Reached the upper limit of tag quota.
    LimitExceeded.TagTagsExceeded Reached the number limit of tag keys.
    ResourceNotFound The resource does not exist.
    UnauthorizedOperation Unauthorized operation.
    UnsupportedOperation.DpdkNatFlowLogOnlySupportAllTrafficType To create a DPDK NAT flow log, the collection type must be All.
    UnsupportedOperation.FlowLogInstanceExisted u200dThere is already a flow log created for the specified ResourceId.
    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.
    UnsupportedOperation.TagAllocate Tags are being assigned.
    UnsupportedOperation.TagFree Tags are being released.
    UnsupportedOperation.TagNotPermit Unauthorized for this tag.
    UnsupportedOperation.TagSystemReservedTagKey The specified tag key is reserved for system usage.
    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy