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

文档中心

立即注册

导航

DescribeTrafficMirrorFilters

最近更新时间：2024.10.21 19:52:31首次发布时间：2023.12.05 07:33:26

调用 DescribeTrafficMirrorFilters 接口，查询满足指定条件的筛选条件。

接口说明

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

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTrafficMirrorFilters	要执行的操作，取值为DescribeTrafficMirrorFilters。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
TrafficMirrorFilterIds.N	String	否	TrafficMirrorFilterIds.1=tmf-bp1opxu1zkhn00123**&TrafficMirrorFilterIds.2=tmf-bp1opxu1zkhn00456*	筛选条件的ID。参数 - N：表示筛选ID的序号，单次调用数量上限为100个。多个筛选条件ID之间用&分隔。
TrafficMirrorFilterNames.N	String	否	TrafficMirrorFilterNames.&=TM_Filter_1&TrafficMirrorFilterNames.2&=TM_Filter_2	筛选条件的名称。参数 - N：表示筛选条件名称的序号，单次调用数量上限为100个。多个筛选条件名称之间用&分隔。
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调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。
TrafficMirrorFilters	Array of struct	-	流量镜像筛选条件的详细信息列表，具体请见下表“TrafficMirrorFilter结构”。

TrafficMirrorFilter结构

参数名称	类型	示例值	描述
TrafficMirrorFilterId	String	tmf-bp1opxu1zkhn00123****	筛选条件的ID。
TrafficMirrorFilterName	String	TM_Filter_1	筛选条件的名称。
Description	String	TM_Filter_1_Description	筛选条件的描述。
Status	String	Available	筛选条件状态。 Available：可用。 Deleting：删除中。 Creating：创建中。
ProjectName	String	default	筛选条件所属项目的名称。
Tags	Array of Struct	-	筛选条件的标签信息。具体请参见下表“Tag结构”。
IngressFilterRules	Array of TrafficMirrorRule	-	入向规则的详细信息列表，具体请见下表“TrafficMirrorRule结构”。
EgressFilterRules	Array of TrafficMirrorRule	-	出向规则详细信息列表，具体请见下表“TrafficMirrorRule结构”。

TrafficMirrorRule结构

参数名称	类型	示例值	描述
TrafficMirrorFilterId	String	tmf-bp1opxu1zkhn00123****	筛选条件的ID。
TrafficMirrorFilterRuleId	String	tmr-j6cmls82xnc86vtpe****	筛选规则的ID。
TrafficDirection	String	ingress	流量的方向。 ingress：入方向。 egress：出方向。
Priority	Integer	1	规则的优先级。
Policy	String	accept	流量采集策略。取值如下： accept：允许。即当镜像源的流量匹配该规则时，复制该流量至镜像目标进行监控分析。 reject：拒绝。即当镜像源的流量匹配该规则时，不复制该流量，拒绝对该流量进行监控分析。
Protocol	String	TCP	流量的协议。 all：含TCP、UDP、ICMP协议。 tcp：TCP协议。 udp：UDP协议。 icmp：ICMP协议。
SourceCidrBlock	String	0.0.0.0/0	流量源网段。
SourcePortRange	String	-1/-1	流量源端口范围。当`Protocol`为icmp、all时，返回-1/-1，表示不限制端口。当`Protocol`为tcp或udp，正斜线（/）隔开起始端口和终止端口。
DestinationCidrBlock	String	0.0.0.0/0	目的网段。
DestinationPortRange	String	-1/-1	流量目的端口范围。当`Protocol`为icmp、all时，返回-1/-1，表示不限制端口。当`Protocol`为tcp或udp，正斜线（/）隔开起始端口和终止端口。
Description	String	TM_FilterRule_1	筛选规则的描述。
Status	String	Available	筛选规则的状态。 Available：可用。 Deleting：删除中。 Creating：创建中。 Pending：修改中。

Tag结构

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

请求示例

GET /?Action=DescribeTrafficMirrorFilters&Version=2020-04-01&TrafficMirrorFilterIds.1=tmf-bp1opxu1zkhn00123****&TrafficMirrorFilterIds.2=tmf-bp1opxu1zkhn00456*** HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeTrafficMirrorFilters",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "TrafficMirrorFilter": [
            {
                "TrafficMirrorFilterId": "tmf-bp1opxu1zkhn00123****",
                "TrafficMirrorFilterName": "TM_Filter_1",
                "Description": "TM_Filter_1_Description",
                "Status": "Available",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key":"k1",
                        "Value":"v1"
                    }
                 ], 
                "IngressFilterRules": [
                    {
                        "TrafficMirrorFilterId": "tmf-bp1opxu1zkhn00123****",
                        "TrafficMirrorFilterRuleId": "tmr-j6cmls82xnc86vtpe****",
                        "TrafficDirection": "ingress",
                        "Priority": 1,
                        "Policy": "accept",
                        "Protocol": "TCP",
                        "SourceCidrBlock": "0.0.0.0/0",
                        "SourcePortRange": "-1/-1",
                        "DestinationCidrBlock": "0.0.0.0/0",
                        "DestinationPortRange": "-1/-1",
                        "Description": "TM_FilterRule_1",
                        "Status": "Available",
                     }
                ],
                "EgressFilterRules": [
                    {
                        "TrafficMirrorFilterId": "tmf-bp1opxu1zkhn00123****",
                        "TrafficMirrorFilterRuleId": "tmr-j6cmls82xnc86v456****",
                        "TrafficDirection": "ingress",
                        "Priority": 1,
                        "Policy": "accept",
                        "Protocol": "TCP",
                        "SourceCidrBlock": "0.0.0.0/0",
                        "SourcePortRange": "-1/-1",
                        "DestinationCidrBlock": "0.0.0.0/0",
                        "DestinationPortRange": "-1/-1",
                        "Description": "TM_FilterRule_2",
                        "Status": "Creating",
                     }
                ]  
             }           
         ]
    }
}

错误码

公共错误码，请参见公共错误码。

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	InvalidTrafficMirrorFilter.Malformed	The specified traffic mirror filter is malformed. Ensure that IDs and names cannot be specified at the same time.	指定的流量镜像筛选条件不合法。请确保不能同时指定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.	已达到单次可指定过滤标签值数量的上限。
400	LimitExceeded.TrafficMirrorFilterIds	You've reached the limit on the number of traffic mirror filter IDs that you can describe.	已达到可查询的镜像流量筛选条件ID数量上限。
400	LimitExceeded.TrafficMirrorFilterNames	You've reached the limit on the number of traffic mirror filter names that you can describe.	已达到可查询的镜像流量筛选条件名数量上限。