1. 接口描述
接口请求域名： vpc.tencentcloudapi.com 。
本接口（DescribeFlowLogs）用于查询获取流日志集合。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeFlowLogs。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| VpcId | 否 | String | 私用网络ID或者统一ID，建议使用统一ID。 示例值：vpc-7zayowkt |
| FlowLogId | 否 | String | 流日志唯一ID。 示例值：fl-hdtpam45 |
| FlowLogName | 否 | String | 流日志实例名字。 示例值：test_name |
| ResourceType | 否 | String | 流日志所属资源类型，VPC|SUBNET|NETWORKINTERFACE。 示例值：VPC |
| ResourceId | 否 | String | 资源唯一ID。 示例值：vpc-7zayowkt |
| TrafficType | 否 | String | 流日志采集类型，ACCEPT|REJECT|ALL。 示例值：ACCEPT |
| CloudLogId | 否 | String | 流日志存储ID。 示例值：10acf9c5-ac0a-45ea-8aeb-bd00312aeebb |
| CloudLogState | 否 | String | 流日志存储ID状态。 示例值：SUCCESS |
| OrderField | 否 | String | 按某个字段排序,支持字段：flowLogName,createTime，默认按createTime。 示例值：createTime |
| OrderDirection | 否 | String | 升序（asc）还是降序（desc）,默认：desc。 示例值：desc |
| Offset | 否 | Integer | 偏移量，默认为0。 示例值：0 |
| Limit | 否 | Integer | 每页行数，默认为10。 示例值：10 |
| Filters | 否 | Filter | 过滤条件，参数不支持同时指定FlowLogId和Filters。 |
| CloudLogRegion | 否 | String | 流日志存储ID对应的地域信息。 示例值：ap-guangzhou |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowLog | Array of FlowLog | 流日志实例集合。 |
| TotalNum | Integer | 流日志总数目。 示例值：2 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询流日志集合
查询流日志集合
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFlowLogs
<公共请求参数>
{
"Limit": 10,
"Offset": 0
}输出示例
{
"Response": {
"FlowLog": [
{
"CloudLogId": "dfb8f1a2-8522-47c1-8571-67905167ab3f",
"CloudLogRegion": "ap-guangzhou",
"CloudLogState": "SUCCESS",
"CreatedTime": "2019-05-07 18:00:26",
"FlowLogDescription": "",
"FlowLogId": "fl-2edhcclz",
"FlowLogName": "yuemingtest",
"ResourceId": "eni-78ysaex1",
"ResourceType": "NETWORKINTERFACE",
"TrafficType": "ACCEPT",
"VpcId": "vpc-pq9vxykj",
"StorageType": "cls",
"FlowLogStorage": {
"StorageTopic": "topic-siqmaox1",
"StorageId": "ckafka-akwiqms1"
},
"TagSet": [],
"Enable": true
},
{
"CloudLogId": "dfb8f1a2-8522-47c1-8571-67905167ab3f",
"CloudLogRegion": "ap-guangzhou",
"CloudLogState": "SUCCESS",
"CreatedTime": "2019-05-08 10:48:26",
"FlowLogDescription": "",
"FlowLogId": "fl-f42uhpkj",
"FlowLogName": "test",
"ResourceId": "eni-78ysaex1",
"ResourceType": "NETWORKINTERFACE",
"TrafficType": "ACCEPT",
"VpcId": "vpc-pq9vxykj",
"StorageType": "cls",
"FlowLogStorage": {
"StorageTopic": "topic-siqmaox1",
"StorageId": "ckafka-akwiqms1"
},
"TagSet": [],
"Enable": true
}
],
"TotalNum": 2,
"RequestId": "404428db-f850-40c2-803d-0aae49aba43a"
}
}示例2 获取流日志信息
获取流日志信息
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFlowLogs
<公共请求参数>
{
"VpcId": "vpc-ew41hsdj",
"FlowLogId": "fl-m4vogmhf"
}输出示例
{
"Response": {
"FlowLog": [
{
"VpcId": "vpc-ew41hsdj",
"FlowLogId": "fl-m4vogmhf",
"FlowLogName": "sflow-nat",
"ResourceType": "NAT",
"ResourceId": "nat-prlux840",
"TrafficType": "ALL",
"CloudLogId": "29a6c8c8-d57d-4e25-84b5-9114734ce6ca",
"CloudLogRegion": "ap-guangzhou",
"CloudLogState": "SUCCESS",
"FlowLogDescription": "",
"CreatedTime": "2022-05-18 15:26:50",
"Enable": true,
"StorageType": "cls",
"FlowLogStorage": {
"StorageId": "29a6c8c8-d57d-4e25-84b5-9114734ce6ca"
},
"TagSet": []
}
],
"TotalNum": 1,
"RequestId": "811bbd89-3c38-4926-9a8c-4bc97792aa34"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.Malformed | 入参格式不合法。 |
| InvalidParameterValue.Range | 参数值不在指定范围。 |
| InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
| ResourceNotFound | 资源不存在。 |
