查询镜像会话的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:ListTrafficMirrorSessions | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| TrafficMirrorSessionName | string | 否 | 镜像会话的名称。 名称长度为 1～128 个字符，不能以 | abc |
| MaxResults | integer | 否 | 本次查询的最大记录条数。取值范围：1~100。默认值：10。 | 10 |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| TrafficMirrorSourceId | string | 否 | 镜像源的实例 ID，目前支持弹性网卡作为镜像源。 | eni-j6c8znm5l1yt4sox***** |
| TrafficMirrorTargetId | string | 否 | 镜像目的的实例 ID，目前支持弹性网卡和私网负载均衡实例作为镜像目的。 | eni-j6c2fp57q8rr47rp**** |
| TrafficMirrorFilterId | string | 否 | 流量镜像筛选条件的实例 ID。 | tmf-j6cmls82xnc86vtpe**** |
| VirtualNetworkId | integer | 否 | 指定 VNI，用来区分不同的镜像流量，取值范围为 0~16777215。您可以通过 VNI 在镜像目的区分不同会话的镜像流量。您可以自定义 VNI 的值，也可以由系统随机分配该值。如果由系统随机分配该值，请不传该参数。 | 10 |
| Priority | integer | 否 | 镜像会话的优先级，取值范围为 1~32766。 数字越小，优先级越高。同一账号在同一个地域创建的镜像会话优先级不能重复。 | 1 |
| Enabled | boolean | 否 | 是否开启流量会话，取值：
| false |
| TrafficMirrorSessionIds | array | 否 | 镜像会话的实例 ID。其中 N 最大取值为 100，即支持查询最多 100 个镜像会话。 | |
| string | 否 | 镜像会话的实例 ID。其中 N 最大取值为 100，即支持查询最多 100 个镜像会话。 | tms-j6cla50buc44ap8tu**** | |
| RegionId | string | 是 | 镜像会话的所属地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。关于流量镜像支持的地域，请参见流量镜像概述。 | cn-hongkong |
| ResourceGroupId | string | 否 | 需要查询的流量镜像所属的资源组 ID。 | rg-bp67acfmxazb4ph**** |
| Tags | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签列表。 | ||
| Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。 一个标签键最多支持 128 个字符，不能以 | FinanceDept |
| Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。 最多支持 128 个字符，不能以 | FinanceJoshua |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "739CA01C-92EB-4C69-BCC0-280149C6F41E",
"TotalCount": "1",
"TrafficMirrorSessions": [
{
"TrafficMirrorTargetId": "eni-j6c2fp57q8rr47rp****",
"TrafficMirrorSessionId": "tms-j6cla50buc44ap8tu****",
"Priority": 1,
"TrafficMirrorTargetType": "NetworkInterface",
"PacketLength": 1500,
"TrafficMirrorSessionDescription": "This is a session.",
"TrafficMirrorSessionStatus": "Created",
"Enabled": false,
"TrafficMirrorSessionBusinessStatus": "Normal",
"VirtualNetworkId": 10,
"TrafficMirrorFilterId": "tmf-j6cmls82xnc86vtpe****",
"TrafficMirrorSessionName": "abc",
"TrafficMirrorSourceIds": [
"eni-j6c8znm5l1yt4sox****"
],
"ResourceGroupId": "rg-bp67acfmxazb4ph****",
"Tags": [
{
"Key": "FinanceDept",
"Value": "FinanceJoshua"
}
],
"CreationTime": "2023-09-05T15:26Z"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is invalid. | 参数NextToken非法. |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-31 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-12-18 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-30 | OpenAPI 描述信息更新 | 查看变更详情 |