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

私有网络

复制全文
下载 pdf
流量镜像
DescribeTrafficMirrorFilters - 查询筛选条件列表
复制全文
下载 pdf
DescribeTrafficMirrorFilters - 查询筛选条件列表
调用 DescribeTrafficMirrorFilters 接口,查询满足指定条件的筛选条件。​
使用说明​
  • 传入多个请求参数,按照传入的参数进行查询,返回符合所有条件的筛选条件,若没有符合条件的筛选条件,则返回空值。​
  • 若请求参数非必选参数均未传入,则按照当前登录账号查询,返回当前账号下的所有筛选条件。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeTrafficMirrorFilters​
接口名称。当前 API 的名称为DescribeTrafficMirrorFilters。​
​
Version String 必选 示例值:2020-04-01​
接口版本。当前 API 的版本为 2020-04-01。​
​
TrafficMirrorFilterIds.N String 可选 示例值:tmf-bp1opxu1zkhn00123****​
筛选条件的ID。​
  • 参数 - N:表示筛选ID的序号,单次调用数量上限为100个。​
  • 多个筛选条件ID之间用&分隔。​
​
TrafficMirrorFilterNames.N String 可选 示例值:TM_Filter_1​
筛选条件的名称。​
  • 参数 - N:表示筛选条件名称的序号,单次调用数量上限为100个。​
  • 多个筛选条件名称之间用&分隔。​
​
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调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。​
​
TrafficMirrorFilters Object[] 示例值:-​
流量镜像筛选条件的详细信息列表。​
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 Object[] 示例值:-​
筛选条件的标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
IngressFilterRules Object[] 示例值:-​
入向规则的详细信息列表。​
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:修改中。​
​
CreatedAt String 示例值:2021-08-05T21:46:55+08:00​
筛选规则的创建时间。​
​
UpdatedAt String 示例值:2021-08-05T21:46:55+08:00​
筛选规则的更新时间。​
​
​
EgressFilterRules Object[] 示例值:-​
出向规则详细信息列表。​
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:修改中。​
​
CreatedAt String 示例值:2021-08-05T21:46:55+08:00​
筛选规则的创建时间。​
​
UpdatedAt String 示例值:2021-08-05T21:46:55+08:00​
筛选规则的更新时间。​
​
​
CreatedAt String 示例值:2021-08-05T21:46:55+08:00​
筛选条件的创建时间。​
​
UpdatedAt String 示例值:2021-08-05T21:46:55+08:00​
筛选条件的更新时间。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeTrafficMirrorFilters&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": "DescribeTrafficMirrorFilters",​
"Version": "2020-04-01",​
"Service": "vpc",​
"Region": "cn-beijing"​
},​
"Result": {​
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",​
"RequestId": "2021062415303301022514515207C4****",​
"TrafficMirrorFilters": [​
{​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"Status": "Available",​
"CreatedAt": "2021-08-05T21:46:55+08:00",​
"UpdatedAt": "2021-08-05T21:46:55+08:00",​
"Description": "TM_Filter_1_Description",​
"ProjectName": "default",​
"EgressFilterRules": [​
{​
"Policy": "accept",​
"Status": "Available",​
"Priority": 1,​
"Protocol": "TCP",​
"CreatedAt": "2021-08-05T21:46:55+08:00",​
"UpdatedAt": "2021-08-05T21:46:55+08:00",​
"Description": "TM_FilterRule_1",​
"SourceCidrBlock": "0.0.0.0/0",​
"SourcePortRange": "-1/-1",​
"TrafficDirection": "ingress",​
"DestinationCidrBlock": "0.0.0.0/0",​
"DestinationPortRange": "-1/-1",​
"TrafficMirrorFilterId": "tmf-bp1opxu1zkhn00123****",​
"TrafficMirrorFilterRuleId": "tmr-j6cmls82xnc86vtpe****"​
}​
],​
"IngressFilterRules": [​
{​
"Policy": "accept",​
"Status": "Available",​
"Priority": 1,​
"Protocol": "TCP",​
"CreatedAt": "2021-08-05T21:46:55+08:00",​
"UpdatedAt": "2021-08-05T21:46:55+08:00",​
"Description": "TM_FilterRule_1",​
"SourceCidrBlock": "0.0.0.0/0",​
"SourcePortRange": "-1/-1",​
"TrafficDirection": "ingress",​
"DestinationCidrBlock": "0.0.0.0/0",​
"DestinationPortRange": "-1/-1",​
"TrafficMirrorFilterId": "tmf-bp1opxu1zkhn00123****",​
"TrafficMirrorFilterRuleId": "tmr-j6cmls82xnc86vtpe****"​
}​
],​
"TrafficMirrorFilterId": "tmf-bp1opxu1zkhn00123****",​
"TrafficMirrorFilterName": "TM_Filter_1"​
}​
]​
}​
}​
​
错误码​
​
状态码​
错误码​
错误信息​
说明​
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​
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.​
已达到可查询的镜像流量筛选条件名数量上限。​
​
​
最近更新时间:2026.10.28 15:20:56
这个页面对您有帮助吗?
有用
有用
无用
无用