DescribeFlowLogs--私有网络-火山引擎

文档中心

立即注册

导航

DescribeFlowLogs

最近更新时间：2024.07.09 08:30:24首次发布时间：2024.01.09 07:24:42

调用 DescribeFlowLogs 接口，查询满足指定条件的流日志。

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的流日志，若没有符合条件的流日志，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有流日志。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeFlowLogs	要执行的操作，取值：DescribeFlowLogs。
Version	String	是	2020-04-01	API版本信息，取值为：2020-04-01。
FlowLogIds.N	String	否	FlowLogIds.1=fl-123456**&FlowLogIds.2=fl-654321**	流日志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	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的流日志。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=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	Array of struct		流日志的详细信息列表，具体请见下表“FlowLogs结构”。

FlowLogs结构

参数名称	类型	示例值	描述
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	Array of Struct	-	流日志的标签信息。具体请参见下表“Tag结构”。
CreatedAt	String	2021-08-05T21:48:55+08:00	创建流日志的时间。
UpdatedAt	String	2021-08-05T21:48:55+08:00	更新流日志的时间。

Tag结构

参数名称	类型	示例值	描述
Key	String	k1	标签的标签键。
Value	String	v1	标签的标签值。

请求示例

GET /?Action=DescribeFlowLogs&Version=2020-04-01&NetworkInterfaceId=eni-bp1fgnh68xyz9**** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeFlowLogs",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
				"NextToken": "caeba0bbb2be03f84eb48b699f0a\*\*\*\*",
        "FlowLogs": [
            {
                "FlowLogId": "fl-123456****",
                "FlowLogName": "FlowLog-1",
                "Description": "FlowLog_VPC",
                "ResourceType": "vpc",
                "ResourceId": "vpc-123456****",
                "TrafficType": "All",
                "AggregationInterval": 10,
                "LogProjectId": "fc69****",
                "LogTopicId": "c6*****",
                "Status": "Active",
                "BusinessStatus": "FinancialLocked",
                "LockReason": "financial",
                "VpcId": "vpc-123456****",
                "Status": "Available",
                "CreatedAt": "2021-07-23T11:55:12+08:00"      
                "UpdatedAt": "2021-07-23T11:55:12+08:00"          
            }
         ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
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.	已达到单次可指定过滤标签值数量的上限。