有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(CreateFlowLog)用于创建网络流日志。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateFlowLog。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
FlowLogName String 流日志实例名字。
示例值:test-flowlog
ResourceType String 流日志所属资源类型,VPC|SUBNET|NETWORKINTERFACE|CCN|NAT|DCG。
示例值:NETWORKINTERFACE
ResourceId String 资源唯一ID。
示例值:eni-12345678
TrafficType String 流日志采集类型,ACCEPT|REJECT|ALL。
示例值:ACCEPT
VpcId String 私用网络ID或者统一ID,建议使用统一ID,当ResourceType为CCN时不填,其他类型必填。
示例值:vpc-12345678
FlowLogDescription String 流日志实例描述。
示例值:test
CloudLogId String 流日志存储ID。
示例值:99991111-2222-4444-9999-222266663333
Tags.N Array of Tag 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。
StorageType String 消费端类型:cls、ckafka。默认值cls。
示例值:cls
FlowLogStorage FlowLogStorage 流日志消费端信息,当消费端类型为ckafka时,必填。
CloudLogRegion String 流日志存储ID对应的地域,不传递默认为本地域。
示例值:ap-guangzhou

3. 输出参数

参数名称 类型 描述
FlowLog Array of FlowLog 创建的流日志信息。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建网络流日志

创建网络流日志

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowLog
<公共请求参数>

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

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.CreateCkafkaRouteError 创建Ckafka路由失败,请稍后重试。
InternalError.ModuleError 内部模块错误。
InvalidParameterValue.Duplicate 入参重复。
InvalidParameterValue.Empty 缺少参数。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.Range 参数值不在指定范围。
InvalidParameterValue.TagDuplicateKey 标签键重复。
InvalidParameterValue.TagDuplicateResourceType 重复的标签资源类型。
InvalidParameterValue.TagInvalidKey 标签键无效。
InvalidParameterValue.TagInvalidKeyLen 标签键长度无效。
InvalidParameterValue.TagInvalidVal 标签值无效。
InvalidParameterValue.TagKeyNotExists 标签键不存在。
InvalidParameterValue.TagNotAllocatedQuota 标签没有分配配额。
InvalidParameterValue.TagNotExisted 该标签不存在。
InvalidParameterValue.TagNotSupportTag 不支持的标签。
InvalidParameterValue.TagResourceFormatError 标签资源格式错误。
InvalidParameterValue.TagTimestampExceeded 标签时间戳超配。
InvalidParameterValue.TagValNotExists 标签值不存在。
LimitExceeded 超过配额限制。
LimitExceeded.ActionLimited 接口请求次数超过限频。
LimitExceeded.TagKeyExceeded 标签键已达到上限。
LimitExceeded.TagKeyPerResourceExceeded 每个资源的标签键已达到上限。
LimitExceeded.TagNotEnoughQuota 没有足够的标签配额。
LimitExceeded.TagQuota 标签配额已满,无法创建资源。
LimitExceeded.TagQuotaExceeded 标签配额已达到上限。
LimitExceeded.TagTagsExceeded 标签键的数目已达到上限。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnsupportedOperation.DpdkNatFlowLogOnlySupportAllTrafficType 创建DPDK NAT流日志时,采集类型只支持全部。
UnsupportedOperation.FlowLogInstanceExisted 指定ResourceId对应的流日志已经创建
UnsupportedOperation.FlowLogsNotSupportKoInstanceEni 不支持创建流日志:当前弹性网卡绑定的是KO机型。
UnsupportedOperation.FlowLogsNotSupportNullInstanceEni 不支持创建流日志:当前弹性网卡未绑定实例。
UnsupportedOperation.OnlySupportProfessionKafka 仅支持专业版Ckafka。
UnsupportedOperation.TagAllocate 标签正在分配中。
UnsupportedOperation.TagFree 标签正在释放中。
UnsupportedOperation.TagNotPermit 标签没有权限。
UnsupportedOperation.TagSystemReservedTagKey 不支持使用系统预留的标签键。