You need to enable JavaScript to run this app.
文档中心
私有网络

私有网络

复制全文
下载 pdf
流日志
DescribeFlowLogs - 查询流日志实例
复制全文
下载 pdf
DescribeFlowLogs - 查询流日志实例
调用 DescribeFlowLogs 接口,查询满足指定条件的流日志。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeFlowLogs​
接口名称。当前 API 的名称为DescribeFlowLogs。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为 2020-04-01。​
​
FlowLogIds.N String 可选 示例值:fl-123456****​
流日志ID​
  • 参数 - N:表示流日志的ID序号,单次调用数量上限100个。​
  • 多个ID之间用&分隔。​
​
FlowLogName String 可选 示例值:FlowLog-1​
流日志名称。​
​
Description String 可选 示例值:FlowLog_VPC​
流日志描述。​
​
ResourceType String 可选 示例值:vpc​
要采集流量的资源类型,取值如下:​
  • vpc:私有网络。​
  • subnet:子网。​
  • eni:网卡。​
​
ResourceId String 可选 示例值:vpc-123456****​
要捕获流量的资源ID。​
​
TrafficType String 可选 示例值:All​
采集的流量类型。取值如下:​
  • All:全部流量。​
  • Allow:网络ACL和安全组允许的流量。​
  • Drop:网络ACL和安全组拒绝的流量​
​
LogProjectId String 可选 示例值:fc69****​
流日志项目的ID。​
​
LogTopicId String 可选 示例值:c6*****​
流日志主题的ID。​
​
AggregationInterval Integer 可选 示例值:10​
流日志的采样间隔。取值如下:​
  • 1:1分钟。​
  • 5:5分钟。​
  • 10:10分钟。​
​
Status String 可选 示例值:Active​
流日志的状态。取值如下:​
  • Active:启动状态。​
  • Pending:正在操作中。​
  • Inactive:未启动状态。​
  • Creating:正在创建中。​
  • Deleting:正在删除中。​
​
VpcId String 可选 示例值:vpc-123456****​
所要查看流日志的VPC的ID。​
您可以调用 DescribeVpcs 接口,查询VPC的ID。​
​
ProjectName String 可选 示例值:default​
流日志所属的项目。​
​
TagFilters.N.Key String 可选 示例值:k1​
标签的标签键。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与(AND)”,即查询同时添加多个标签键的流日志。​
​
TagFilters.N.Values.N String 可选 示例值:v1​
标签的标签值。​
  • 第一个N:表示标签键的序号。​
  • 第二个N:表示标签值的序号,取值范围:1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”,即查询同一标签键下添加其中一个标签值的流日志。​
  • 多个标签值之间用&分隔。​
说明​
  • 若传入该参数,则必须先传入TagFilters.N.Key。​
  • 传入空字符串时,表示查询标签值为空的流日志。​
​
NextToken String 可选 示例值:caeba0bbb2be03f84eb48b699f0a****​
分页查询凭证,用于标记分页的位置。​
  • 不填则从头开始查询。​
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。​
​
MaxResults Integer 可选 示例值:50​
查询的数量,默认为 10,最大为100。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId String 示例值:2021062415303301022514515207C4****​
请求ID。​
​
NextToken String 示例值:caeba0bbb2be03f84eb48b699f0a****​
本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。​
​
FlowLogs Object[] 示例值:-​
流日志的详细信息列表。​
FlowLogId String 示例值:fl-123456****​
流日志ID。​
​
FlowLogName String 示例值:FlowLog-1​
流日志名称。​
​
Description String 示例值:FlowLog_VPC​
流日志描述。​
​
ResourceType String 示例值:vpc​
要捕获流量的资源类型。​
​
ResourceId String 示例值:vpc-123456****​
要捕获流量的资源ID。​
​
TrafficType String 示例值:All​
采集的流量类型。​
​
AggregationInterval Integer 示例值:10​
流日志的采样间隔。单位:分钟。​
​
LogProjectId String 示例值:fc69****​
流日志项目的ID。​
​
LogTopicId String 示例值:c6*****​
流日志主题的ID。​
​
Status String 示例值:Active​
流日志的状态。​
​
BusinessStatus String 示例值:FinancialLocked​
流日志是否被锁定。​
  • Normal: 正常。​
  • FinancialLocked: 被锁定。​
​
LockReason String 示例值:financial​
流日志被锁定的原因。​
  • financial: 因欠费被锁定。​
  • unlock:欠费关停后充值恢复过程中。​
  • 空值 : 没有被锁定。​
​
VpcId String 示例值:vpc-123456****​
所要查看流日志的VPC的ID。​
​
ProjectName String 示例值:default​
流日志所属项目的名称。​
​
Tags Object[] 示例值:-​
流日志的标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
CreatedAt String 示例值:2021-08-05T21:48:55+08:00​
创建流日志的时间。​
​
UpdatedAt String 示例值:2021-08-05T21:48:55+08:00​
更新流日志的时间。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeFlowLogs&Version=2020-04-01&NextToken=caeba0bbb2be03f84eb48b699f0a****&MaxResults=50 HTTP/1.1​
Host: vpc.cn-beijing.volcengineapi.com​
X-Date: 20250804T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-beijing/vpc/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeFlowLogs",​
"Version": "2020-04-01",​
"Service": "vpc",​
"Region": "cn-beijing"​
},​
"Result": {​
"FlowLogs": [​
{​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"VpcId": "vpc-123456****",​
"Status": "Active",​
"CreatedAt": "2021-08-05T21:48:55+08:00",​
"FlowLogId": "fl-123456****",​
"UpdatedAt": "2021-08-05T21:48:55+08:00",​
"LockReason": "financial",​
"LogTopicId": "c6*****",​
"ResourceId": "vpc-123456****",​
"Description": "FlowLog_VPC",​
"FlowLogName": "FlowLog-1",​
"ProjectName": "default",​
"TrafficType": "All",​
"LogProjectId": "fc69****",​
"ResourceType": "vpc",​
"BusinessStatus": "FinancialLocked",​
"AggregationInterval": 10​
}​
],​
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",​
"RequestId": "2021062415303301022514515207C4****"​
}​
}​
​
错误码​
​
状态码​
错误码​
错误信息​
说明​
400​
DryRunOperation​
Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.​
该请求设置为DryRun操作,操作授权已获得许可,但未被实际执行。​
400​
InvalidMaxResults.Malformed​
The specified parameter MaxResults is malformed.​
查询数量不合法。​
400​
InvalidNextToken.Malformed​
The specified parameter NextToken is invalid.​
查询 NextToken 不合法。​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
InvalidTagFilter.Disorder​
The specified index order of tag filter is malformed.​
指定标签过滤项的索引顺序参数格式不合法。​
400​
InvalidTagFilterKey.Malformed​
The specified parameter tag filter key is invalid.​
过滤标签键不合法。​
400​
InvalidTagFilterValue.Malformed​
The specified parameter tag filter value is invalid.​
过滤标签值不合法。​
400​
LimitExceeded.FlowLogIDs​
You've reached the limit on the number of flow log IDs that you can describe.​
已达到可查询的流日志ID数量上限。​
400​
LimitExceeded.TagFilterKey​
You've reached the limit on the number of tag keys that you can filter.​
已达到单次可指定过滤标签键数量的上限。​
400​
LimitExceeded.TagFilterValue​
You've reached the limit on the number of tag values that you can filter.​
已达到单次可指定过滤标签值数量的上限。​
​
​
最近更新时间:2026.08.12 11:42:46
这个页面对您有帮助吗?
有用
有用
无用
无用