更新时间:2025-08-19 GMT+08:00

更新流量镜像会话

功能介绍

更新流量镜像会话。

调用方法

请参见如何调用API

URI

PUT /v3/{project_id}/vpc/traffic-mirror-sessions/{traffic_mirror_session_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

流量镜像会话所属的项目ID。获取方式请参见获取项目ID

取值范围

不涉及。

traffic_mirror_session_id

String

流量镜像会话ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

traffic_mirror_session

UpdateTrafficMirrorSessionOption object

流量镜像会话对象

表3 UpdateTrafficMirrorSessionOption

参数

是否必选

参数类型

描述

name

String

功能说明:流量镜像会话名称

取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

description

String

功能说明:流量镜像会话的描述信息

取值范围:0-255个字符,不能包含“<”和“>”

traffic_mirror_filter_id

String

功能说明:流量镜像筛选条件ID

traffic_mirror_target_id

String

功能说明:镜像目标ID

traffic_mirror_target_type

String

功能说明:镜像目的类型

取值范围:

eni:弹性网卡

elb:私网弹性负载均衡

virtual_network_id

Integer

功能说明:指定VNI,用于在镜像目的区分不同会话的镜像流量

取值范围:0~16777215

packet_length

Integer

功能说明:最大传输单元MTU

取值范围:1~1460

priority

Integer

功能说明:会话优先级

取值范围:1~32766

enabled

String

功能说明:是否开启会话

取值范围:true、false

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

traffic_mirror_session

TrafficMirrorSession object

参数解释

查询流量镜像会话详情的响应体。

取值范围

不涉及。

request_id

String

参数解释

请求ID。

取值范围

不涉及。

表5 TrafficMirrorSession

参数

参数类型

描述

id

String

参数解释

流量镜像会话的资源ID。流量镜像会话创建成功后,会生成一个流量镜像会话 ID,是流量镜像会话对应的唯一标识。

取值范围

不涉及。

project_id

String

参数解释

流量镜像会话所属的项目ID。

取值范围

不涉及。

name

String

参数解释

流量镜像会话的名称。

取值范围

1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。

description

String

参数解释

流量镜像会话的描述信息。

取值范围

0-255个字符,不能包含“<”和“>”。

traffic_mirror_filter_id

String

参数解释

流量镜像会话关联的筛选条件的ID。

取值范围

不涉及。

traffic_mirror_sources

Array of strings

参数解释

流量镜像会话关联的镜像源的ID列表,支持弹性网卡作为镜像源。

取值范围

一个流量镜像会话默认最大支持10个镜像源。

traffic_mirror_target_id

String

参数解释

流量镜像会话关联的镜像目的ID。

取值范围

不涉及。

traffic_mirror_target_type

String

参数解释

流量镜像会话关联的镜像目的的类型。

取值范围

  • eni:镜像目的类型是弹性网卡。

  • elb:镜像目的类型是私网弹性负载均衡。

virtual_network_id

Integer

参数解释

流量镜像会话的VXLAN网络标识(VNI),用于区分不同会话的镜像流量。

取值范围

0~16777215,默认值是1。

packet_length

Integer

参数解释

流量镜像会话的镜像报文长度。

取值范围

1~1460,默认值是96。

priority

Integer

参数解释

流量镜像会话的优先级。

取值范围

1~32766。

enabled

Boolean

参数解释

是否开启流量镜像会话。

取值范围

  • true:开启流量镜像会话。

  • false:默认值,关闭流量镜像会话。

type

String

参数解释

流量镜像会话的镜像源的类型。

取值范围

  • eni:弹性网卡

  • eip:弹性公网IP

created_at

String

参数解释

流量镜像会话的创建时间。

取值范围

UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

updated_at

String

参数解释

流量镜像会话的更新时间。

取值范围

UTC时间格式,yyyy-MM-ddTHH:mm:ssZ。

请求示例

更新ID为16538eda-7e94-4b90-b5f3-a653f62dc817的流量镜像会话,镜像目的类型为elb,镜像目的ID为c9f8acef-d550-4fbe-be7c-e8bfd3501dc1

PUT http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions/16538eda-7e94-4b90-b5f3-a653f62dc817

{
  "traffic_mirror_session" : {
    "traffic_mirror_target_id" : "c9f8acef-d550-4fbe-be7c-e8bfd3501dc1",
    "traffic_mirror_target_type" : "elb"
  }
}

响应示例

状态码:200

OK

{
  "traffic_mirror_session" : {
    "name" : "test-session",
    "created_at" : "2023-03-23T10:53:12.000+00:00",
    "updated_at" : "2023-03-23T10:56:54.000+00:00",
    "id" : "16538eda-7e94-4b90-b5f3-a653f62dc817",
    "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" : "c9f8acef-d550-4fbe-be7c-e8bfd3501dc1",
    "traffic_mirror_target_type" : "elb",
    "virtual_network_id" : 1,
    "packet_length" : 96,
    "priority" : 11,
    "enabled" : true,
    "type" : "eni"
  },
  "request_id" : "a7ee4a0e-12e9-457a-b739-46bffb2e7bbb"
}

SDK代码示例

SDK代码示例如下。

更新ID为16538eda-7e94-4b90-b5f3-a653f62dc817的流量镜像会话,镜像目的类型为elb,镜像目的ID为c9f8acef-d550-4fbe-be7c-e8bfd3501dc1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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 UpdateTrafficMirrorSessionSolution {

    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("<YOUR REGION>"))
                .build();
        UpdateTrafficMirrorSessionRequest request = new UpdateTrafficMirrorSessionRequest();
        request.withTrafficMirrorSessionId("{traffic_mirror_session_id}");
        UpdateTrafficMirrorSessionRequestBody body = new UpdateTrafficMirrorSessionRequestBody();
        UpdateTrafficMirrorSessionOption trafficMirrorSessionbody = new UpdateTrafficMirrorSessionOption();
        trafficMirrorSessionbody.withTrafficMirrorTargetId("c9f8acef-d550-4fbe-be7c-e8bfd3501dc1")
            .withTrafficMirrorTargetType("elb");
        body.withTrafficMirrorSession(trafficMirrorSessionbody);
        request.withBody(body);
        try {
            UpdateTrafficMirrorSessionResponse response = client.updateTrafficMirrorSession(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());
        }
    }
}

更新ID为16538eda-7e94-4b90-b5f3-a653f62dc817的流量镜像会话,镜像目的类型为elb,镜像目的ID为c9f8acef-d550-4fbe-be7c-e8bfd3501dc1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateTrafficMirrorSessionRequest()
        request.traffic_mirror_session_id = "{traffic_mirror_session_id}"
        trafficMirrorSessionbody = UpdateTrafficMirrorSessionOption(
            traffic_mirror_target_id="c9f8acef-d550-4fbe-be7c-e8bfd3501dc1",
            traffic_mirror_target_type="elb"
        )
        request.body = UpdateTrafficMirrorSessionRequestBody(
            traffic_mirror_session=trafficMirrorSessionbody
        )
        response = client.update_traffic_mirror_session(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

更新ID为16538eda-7e94-4b90-b5f3-a653f62dc817的流量镜像会话,镜像目的类型为elb,镜像目的ID为c9f8acef-d550-4fbe-be7c-e8bfd3501dc1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := vpc.NewVpcClient(
        vpc.VpcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateTrafficMirrorSessionRequest{}
	request.TrafficMirrorSessionId = "{traffic_mirror_session_id}"
	trafficMirrorTargetIdTrafficMirrorSession:= "c9f8acef-d550-4fbe-be7c-e8bfd3501dc1"
	trafficMirrorTargetTypeTrafficMirrorSession:= "elb"
	trafficMirrorSessionbody := &model.UpdateTrafficMirrorSessionOption{
		TrafficMirrorTargetId: &trafficMirrorTargetIdTrafficMirrorSession,
		TrafficMirrorTargetType: &trafficMirrorTargetTypeTrafficMirrorSession,
	}
	request.Body = &model.UpdateTrafficMirrorSessionRequestBody{
		TrafficMirrorSession: trafficMirrorSessionbody,
	}
	response, err := client.UpdateTrafficMirrorSession(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码