Help Center/ Virtual Private Cloud/ API Reference/ VPC APIs (V3)/ Traffic Mirror Sessions/ Disassociating a Traffic Mirror Source from a Traffic Mirror Session
Updated on 2025-08-19 GMT+08:00

Disassociating a Traffic Mirror Source from a Traffic Mirror Session

Function

This API is used to disassociate a traffic mirror source from a traffic mirror session.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

For details about how to obtain a project ID, see Obtaining a Project ID.

traffic_mirror_session_id

Yes

String

Traffic mirror session ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

traffic_mirror_session

Yes

TrafficMirrorSourcesOption object

Traffic mirror session.

Table 3 TrafficMirrorSourcesOption

Parameter

Mandatory

Type

Description

traffic_mirror_sources

Yes

Array of strings

Traffic mirror source IDs.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

traffic_mirror_session

TrafficMirrorSession object

Definition:

Response body for querying details about a traffic mirror session.

Range:

N/A

request_id

String

Definition:

Request ID.

Range:

N/A

Table 5 TrafficMirrorSession

Parameter

Type

Description

id

String

Definition:

ID of a traffic mirror session. After a traffic mirror session is created, a traffic mirror session ID is generated, which uniquely identifies the traffic mirror session.

Range:

N/A

project_id

String

Definition:

ID of the project that a traffic mirror session belongs to.

Range:

N/A

name

String

Definition:

Name of a traffic mirror session.

Range:

The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods.

description

String

Definition:

Description of a traffic mirror session.

Range:

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

traffic_mirror_filter_id

String

Definition:

ID of the traffic mirror filter that a traffic mirror session is associated with.

Range:

N/A

traffic_mirror_sources

Array of strings

Definition:

IDs of the traffic mirror sources that a traffic mirror session is associated with. Elastic network interfaces can be used as the traffic mirror sources.

Range:

Each traffic mirror session can have up to 10 mirror sources by default.

traffic_mirror_target_id

String

Definition:

ID of the traffic mirror target that a traffic mirror session is associated with.

Range:

N/A

traffic_mirror_target_type

String

Definition:

Type of the traffic mirror target that a traffic mirror session is associated with.

Range:

  • eni: The mirror target is an elastic network interface.

  • elb: The mirror target is a private network load balancer.

virtual_network_id

Integer

Definition:

VXLAN network identifier (VNI) of a traffic mirror session, which is used to distinguish different mirror sessions.

Range:

The value is from 0 to 16777215. The default value is 1.

packet_length

Integer

Definition:

Packet length of a traffic mirror session.

Range:

The value is from 1 to 1460. The default value is 96.

priority

Integer

Definition:

Priority of a traffic mirror session.

Range:

1 to 32766

enabled

Boolean

Definition:

Whether to enable a traffic mirror session.

Range:

  • true: The traffic mirror session is enabled.

  • false (default value): The traffic mirror session is disabled.

type

String

Definition:

Type of the traffic mirror source that a traffic mirror session is associated with.

Range:

  • eni: elastic network interface

  • eip: EIP

created_at

String

Definition:

Time when a traffic mirror session was created.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.

updated_at

String

Definition:

Time when a traffic mirror session was updated.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.

Example Requests

Disassociate the mirror source with ID of 6134900d-31a6-4b71-8453-dbca7f26982a from the mirror session with ID of e15a6e40-2580-4949-bf2a-55ee7cd49392.

PUT https://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions/e15a6e40-2580-4949-bf2a-55ee7cd49392/remove-sources

{
  "traffic_mirror_session" : {
    "traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982a" ]
  }
}

Example Responses

Status code: 200

OK

{
  "traffic_mirror_session" : {
    "name" : "test-session",
    "created_at" : "2023-02-23T06:57:39.000+00:00",
    "updated_at" : "2023-02-23T06:57:39.000+00:00",
    "id" : "e15a6e40-2580-4949-bf2a-55ee7cd49392",
    "project_id" : "7365fcd452924e398ec4cc1fe39c0d12",
    "description" : "",
    "traffic_mirror_filter_id" : "b765ba87-c0b4-4f1a-9ec3-d5b1d1ddb137",
    "traffic_mirror_sources" : [ ],
    "traffic_mirror_target_id" : "",
    "traffic_mirror_target_type" : "",
    "virtual_network_id" : 1,
    "packet_length" : 96,
    "priority" : 6,
    "enabled" : true,
    "type" : "eni"
  },
  "request_id" : "6f107fc1-93be-4d5a-af71-4099da7eeaa9"
}

SDK Sample Code

The SDK sample code is as follows.

Disassociate the mirror source with ID of 6134900d-31a6-4b71-8453-dbca7f26982a from the mirror session with ID of e15a6e40-2580-4949-bf2a-55ee7cd49392.

 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
55
56
57
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.*;

import java.util.List;
import java.util.ArrayList;

public class RemoveSourcesFromTrafficMirrorSessionSolution {

    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();
        RemoveSourcesFromTrafficMirrorSessionRequest request = new RemoveSourcesFromTrafficMirrorSessionRequest();
        request.withTrafficMirrorSessionId("{traffic_mirror_session_id}");
        RemoveSourcesFromTrafficMirrorSessionRequestBody body = new RemoveSourcesFromTrafficMirrorSessionRequestBody();
        List<String> listTrafficMirrorSessionTrafficMirrorSources = new ArrayList<>();
        listTrafficMirrorSessionTrafficMirrorSources.add("6134900d-31a6-4b71-8453-dbca7f26982a");
        TrafficMirrorSourcesOption trafficMirrorSessionbody = new TrafficMirrorSourcesOption();
        trafficMirrorSessionbody.withTrafficMirrorSources(listTrafficMirrorSessionTrafficMirrorSources);
        body.withTrafficMirrorSession(trafficMirrorSessionbody);
        request.withBody(body);
        try {
            RemoveSourcesFromTrafficMirrorSessionResponse response = client.removeSourcesFromTrafficMirrorSession(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());
        }
    }
}

Disassociate the mirror source with ID of 6134900d-31a6-4b71-8453-dbca7f26982a from the mirror session with ID of e15a6e40-2580-4949-bf2a-55ee7cd49392.

 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
# 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 = RemoveSourcesFromTrafficMirrorSessionRequest()
        request.traffic_mirror_session_id = "{traffic_mirror_session_id}"
        listTrafficMirrorSourcesTrafficMirrorSession = [
            "6134900d-31a6-4b71-8453-dbca7f26982a"
        ]
        trafficMirrorSessionbody = TrafficMirrorSourcesOption(
            traffic_mirror_sources=listTrafficMirrorSourcesTrafficMirrorSession
        )
        request.body = RemoveSourcesFromTrafficMirrorSessionRequestBody(
            traffic_mirror_session=trafficMirrorSessionbody
        )
        response = client.remove_sources_from_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)

Disassociate the mirror source with ID of 6134900d-31a6-4b71-8453-dbca7f26982a from the mirror session with ID of e15a6e40-2580-4949-bf2a-55ee7cd49392.

 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.RemoveSourcesFromTrafficMirrorSessionRequest{}
	request.TrafficMirrorSessionId = "{traffic_mirror_session_id}"
	var listTrafficMirrorSourcesTrafficMirrorSession = []string{
        "6134900d-31a6-4b71-8453-dbca7f26982a",
    }
	trafficMirrorSessionbody := &model.TrafficMirrorSourcesOption{
		TrafficMirrorSources: listTrafficMirrorSourcesTrafficMirrorSession,
	}
	request.Body = &model.RemoveSourcesFromTrafficMirrorSessionRequestBody{
		TrafficMirrorSession: trafficMirrorSessionbody,
	}
	response, err := client.RemoveSourcesFromTrafficMirrorSession(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.