# 查询流量镜像会话列表 - ListTrafficMirrorSessions #### 功能介绍 当您的流量镜像会话创建成功后，您可以通过该接口查询所有流量镜像会话信息，包括流量镜像会话的名称、类型等。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-vpc/vpc_api00_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpc/vpc_permission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpc:trafficMirrorSessions:list | List | trafficMirrorSession \* | - | - | - | #### URI GET /v3/{project_id}/vpc/traffic-mirror-sessions 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 流量镜像会话所属的项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html)。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | Array of strings | **参数解释**： 流量镜像会话的资源ID，可以通过此字段精确过滤流量镜像会话，支持传入多个ID过滤。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | name | 否 | Array of strings | **参数解释**： 流量镜像会话的名称，可以通过此字段过滤流量镜像会话，支持传入多个名称过滤。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | description | 否 | Array of strings | **参数解释**： 流量镜像会话的描述信息，可以通过此字段过滤流量镜像会话，支持传入多个描述信息进行过滤。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | enabled | 否 | Boolean | **参数解释**： 是否开启流量镜像会话，可以通过此字段过滤流量镜像会话，不支持传入多个值过滤。 **约束限制**： 不涉及。 **取值范围**： - true：过滤出开启状态的流量镜像会话。 - false：过滤出关闭状态的流量镜像会话。 **默认取值**： 不涉及。 | | packet_length | 否 | Array of integers | **参数解释**： 流量镜像会话的镜像报文长度，可以通过此字段过滤流量镜像会话，支持传入多个镜像报文长度过滤。 **约束限制**： 不涉及。 **取值范围**： 1\~1460 bytes。 **默认取值**： 不涉及。 | | priority | 否 | Array of integers | **参数解释**： 流量镜像会话的优先级，可以通过此字段过滤流量镜像会话，支持传入多个优先级过滤。 **约束限制**： 不涉及。 **取值范围**： 1\~32766 **默认取值**： 不涉及。 | | traffic_mirror_filter_id | 否 | Array of strings | **参数解释**： 流量镜像会话关联的筛选条件的ID，可以通过此字段过滤流量镜像会话，支持传入多个ID过滤。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | traffic_mirror_target_type | 否 | Array of strings | **参数解释**： 流量镜像会话的镜像目的类型，可以通过此字段过滤流量镜像会话，支持传入多个类型过滤。 **约束限制**： 不涉及。 **取值范围**： - eni：镜像目的类型是弹性网卡。 - elb：镜像目的类型是私网弹性负载均衡。 **默认取值**： 不涉及。 | | traffic_mirror_target_id | 否 | Array of strings | **参数解释**： 流量镜像会话的镜像目的ID，可以通过此字段过滤流量镜像会话，支持传入多个ID过滤。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | type | 否 | Array of strings | **参数解释**： 流量镜像会话的镜像源类型，可以通过此字段过滤流量镜像会话，支持传入多个类型过滤。 **约束限制**： 不涉及。 **取值范围**： - eni：弹性网卡 - eip：弹性公网IP **默认取值**： 不涉及。 | | virtual_network_id | 否 | Array of integers | **参数解释**： 流量镜像会话的VXLAN网络标识（VNI），可以通过此字段过滤流量镜像会话，支持传入多个VNI过滤。 **约束限制**： 不涉及。 **取值范围**： 0\~16777215 **默认取值**： 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | traffic_mirror_sessions | Array of [TrafficMirrorSession] objects | **参数解释**： 查询流量镜像会话列表的响应体。 **取值范围**： 不涉及。 | | page_info | [PageInfo] object | **参数解释**： 分页信息 **取值范围**： 不涉及。 | | request_id | String | **参数解释**： 请求ID。 **取值范围**： 不涉及。 | 表4TrafficMirrorSession | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 流量镜像会话的资源ID。流量镜像会话创建成功后，会生成一个流量镜像会话 ID，是流量镜像会话对应的唯一标识。 **取值范围**： 不涉及。 | | project_id | String | **参数解释**： 流量镜像会话所属的项目ID。 **取值范围**： 不涉及。 | | name | String | **参数解释**： 流量镜像会话的名称。 **取值范围**： 不涉及。 | | description | String | **参数解释**： 流量镜像会话的描述信息。 **取值范围**： 不涉及。 | | traffic_mirror_filter_id | String | **参数解释**： 流量镜像会话关联的筛选条件的ID。 **取值范围**： 不涉及。 | | traffic_mirror_sources | Array of strings | **参数解释**： 流量镜像会话关联的镜像源的ID列表，支持弹性网卡作为镜像源。 **取值范围**： 不涉及。 | | traffic_mirror_target_id | String | **参数解释**： 流量镜像会话关联的镜像目的ID。 **取值范围**： 不涉及。 | | traffic_mirror_target_type | String | **参数解释**： 流量镜像会话关联的镜像目的的类型。 **取值范围**： - eni：镜像目的类型是弹性网卡。 - elb：镜像目的类型是私网弹性负载均衡。 | | virtual_network_id | Integer | **参数解释**： 指定VNI ：VXLAN网络标识（VXLAN Network Identifier)，简称为VNI。 由于一个镜像目的可以被关联至多个镜像会话，因此对于镜像目的来说，VNI用来区分不同的镜像会话。 **取值范围**： 0\~16777215 | | packet_length | Integer | **参数解释**： 镜像报文长度，表示符合筛选条件，被镜像的报文长度。 **取值范围**： 1\~1460 bytes | | priority | Integer | **参数解释**： 镜像会话优先级。 **取值范围**： 1\~32766，数字越小，表示优先级越高。 | | enabled | Boolean | **参数解释**： 是否开启流量镜像会话。 **取值范围**： - true：开启流量镜像会话。 - false：默认值，关闭流量镜像会话。 | | type | String | **参数解释**： 流量镜像会话的镜像源的类型。 **取值范围**： - eni：弹性网卡 - eip：弹性公网IP | | created_at | String | **参数解释**： 流量镜像会话的创建时间。 **取值范围**： 不涉及。 | | updated_at | String | **参数解释**： 流量镜像会话的更新时间。 **取值范围**： 不涉及。 | 表5PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | previous_marker | String | **参数解释**： 当前页的第一条记录。 **取值范围**： 不涉及。 | | current_count | Integer | **参数解释**： 当前页的资源总数。 **取值范围**： 不涉及。 | | next_marker | String | **参数解释**： 当前页的最后一条记录，最后一页时无next_marker字段。 **取值范围**： 不涉及。 | #### 请求示例 查询流量镜像会话列表 ``` GET http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions ``` #### 响应示例 **状态码：200** OK ``` { "request_id" : "f87354b7-eecd-4b64-87f6-bfd6430e33bd", "traffic_mirror_sessions" : [ { "name" : "test-session", "created_at" : "2023-03-14T08:44:12.000+00:00", "updated_at" : "2023-03-14T08:44:12.000+00:00", "id" : "6cc12480-5a92-4aed-99fb-07c52cc98961", "project_id" : "7365fcd452924e398ec4cc1fe39c0d12", "description" : "", "traffic_mirror_filter_id" : "b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137", "traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982a" ], "traffic_mirror_target_id" : "029ab12b-dc38-4228-b146-44975bf55250", "traffic_mirror_target_type" : "eni", "virtual_network_id" : 1, "packet_length" : 96, "priority" : 9, "enabled" : true, "type" : "eni" } ], "page_info" : { "previous_marker" : "6cc12480-5a92-4aed-99fb-07c52cc98961", "current_count" : 1 } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.vpc.v3.region.VpcRegion; import com.huaweicloud.sdk.vpc.v3.*; import com.huaweicloud.sdk.vpc.v3.model.*; public class ListTrafficMirrorSessionsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); VpcClient client = VpcClient.newBuilder() .withCredential(auth) .withRegion(VpcRegion.valueOf("")) .build(); ListTrafficMirrorSessionsRequest request = new ListTrafficMirrorSessionsRequest(); try { ListTrafficMirrorSessionsResponse response = client.listTrafficMirrorSessions(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpc.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = VpcClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcRegion.value_of("")) \ .build() try: request = ListTrafficMirrorSessionsRequest() response = client.list_traffic_mirror_sessions(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := vpc.VpcClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := vpc.NewVpcClient(hcClient) request := &model.ListTrafficMirrorSessionsRequest{} response, err := client.ListTrafficMirrorSessions(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/VPC/sdk?api=ListTrafficMirrorSessions&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-vpc/vpc_api_0003.html)。