Updated on 2025-08-19 GMT+08:00

Updating a Traffic Mirror Filter

Function

This API is used to update a traffic mirror filter.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/vpc/traffic-mirror-filters/{traffic_mirror_filter_id}

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_filter_id

Yes

String

Traffic mirror filter ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

traffic_mirror_filter

Yes

UpdateTrafficMirrorFilterOption object

Traffic mirror filter.

Table 3 UpdateTrafficMirrorFilterOption

Parameter

Mandatory

Type

Description

description

No

String

Description of a traffic mirror filter.

The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

name

No

String

Traffic mirror filter name.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

traffic_mirror_filter

TrafficMirrorFilter object

Definition:

Response body for querying details about a traffic mirror filter.

Range:

N/A

request_id

String

Definition:

Request ID.

Range:

N/A

Table 5 TrafficMirrorFilter

Parameter

Type

Description

id

String

Definition:

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

Range:

N/A

project_id

String

Definition:

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

Range:

N/A

description

String

Definition:

Description of a traffic mirror filter.

Range:

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

name

String

Definition:

Name of a traffic mirror filter.

Range:

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

ingress_rules

Array of TrafficMirrorFilterRule objects

Definition:

Inbound mirror filter rules in a traffic mirror filter.

Range:

N/A

egress_rules

Array of TrafficMirrorFilterRule objects

Definition:

Outbound mirror filter rules in a traffic mirror filter.

Range:

N/A

created_at

String

Definition:

Time when a traffic mirror filter 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 filter was updated.

Range:

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

type

String

Definition:

Mirror source type of a traffic mirror filter.

Range:

  • eni: elastic network interface

Table 6 TrafficMirrorFilterRule

Parameter

Type

Description

id

String

Definition:

ID of a traffic mirror filter rule.

Range:

N/A

project_id

String

Definition:

ID of the project that a traffic mirror filter rule belongs to.

Range:

N/A

description

String

Definition:

Description of a traffic mirror filter rule.

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 filter rule belongs to.

Range:

N/A

direction

String

Definition:

Traffic direction of a traffic mirror filter rule.

Range:

  • ingress: inbound traffic

  • egress: outbound traffic

source_cidr_block

String

Definition:

Source of a traffic mirror filter rule.

Range:

  • Single IP address: IP address/subnet mask. For example, 192.168.10.10/32 for a single IPv4 address or 2002:50::44/128 for a single IPv6 address.

  • CIDR block: IP address/subnet mask. For example, 192.168.52.0/24 for an IPv4 CIDR block or 2407:c080:802:469::/64 for an IPv6 CIDR block.

  • All IP addresses: 0.0.0.0/0 indicates all IPv4 addresses, and ::/0 indicates all IPv6 addresses.

destination_cidr_block

String

Definition:

Destination of a traffic mirror filter rule.

Range:

  • Single IP address: IP address/subnet mask. For example, 192.168.10.10/32 for a single IPv4 address or 2002:50::44/128 for a single IPv6 address.

  • CIDR block: IP address/subnet mask. For example, 192.168.52.0/24 for an IPv4 CIDR block or 2407:c080:802:469::/64 for an IPv6 CIDR block.

  • All IP addresses: 0.0.0.0/0 indicates all IPv4 addresses, and ::/0 indicates all IPv6 addresses.

source_port_range

String

Definition:

Source port range of a traffic mirror filter rule.

Range:

  • Port range: 1 to 65535

  • Use a hyphen (-) to connect the start port and the end port, for example, 22-23. The end port cannot be smaller than the start port.

destination_port_range

String

Definition:

Destination port range of a traffic mirror filter rule.

Range:

  • Port range: 1 to 65535

  • Use a hyphen (-) to connect the start port and the end port, for example, 22-23. The end port cannot be smaller than the start port.

ethertype

String

Definition:

IP address version.

Range:

IPv4 or IPv6

protocol

String

Definition:

Network protocol type.

Range:

  • TCP: If you select TCP, you can customize the source and destination port ranges.

  • UDP: If you select UDP, you can customize the source and destination port ranges.

  • ICMP: If you set IP address version to IPv4 and select ICMP, all ports are specified for source and destination port ranges by default.

  • ICMPV6: If you set IP address version to IPv6 and select ICMPv6, all ports are specified for source and destination port ranges by default.

  • ALL: If you select ALL, all network protocols are supported and all ports are specified for source and destination port ranges by default.

action

String

Definition:

Action of a traffic mirror filter rule.

Range:

  • accept

  • reject

priority

Integer

Definition:

Priority of a traffic mirror filter rule.

Range:

The value is from 1 to 65535. A smaller value indicates a higher priority.

created_at

String

Definition:

Time when a traffic mirror filter rule 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 filter rule was updated.

Range:

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

Example Requests

Change the name of the traffic mirror filter whose ID is 59d2b2e7-0d35-41f7-a12e-f7699366cd21 to test1.

PUT /v3/{project_id}/vpc/traffic-mirror-filters/59d2b2e7-0d35-41f7-a12e-f7699366cd21

{
  "traffic_mirror_filter" : {
    "name" : "test1",
    "description" : "description"
  }
}

Example Responses

Status code: 200

OK

{
  "traffic_mirror_filter" : {
    "id" : "59d2b2e7-0d35-41f7-a12e-f7699366cd21",
    "project_id" : "49a42f378df747bf8b8f6a70e25b63fb",
    "name" : "test1",
    "description" : "description",
    "ingress_rules" : [ ],
    "egress_rules" : [ ],
    "created_at" : "2022-08-29T06:22:01.000+00:00",
    "updated_at" : "2022-08-29T06:22:01.000+00:00"
  },
  "request_id" : "f05abcd9-fa75-43a5-a795-b3d8e8b7a9e9"
}

SDK Sample Code

The SDK sample code is as follows.

Change the name of the traffic mirror filter whose ID is 59d2b2e7-0d35-41f7-a12e-f7699366cd21 to test1.

 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 UpdateTrafficMirrorFilterSolution {

    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();
        UpdateTrafficMirrorFilterRequest request = new UpdateTrafficMirrorFilterRequest();
        request.withTrafficMirrorFilterId("{traffic_mirror_filter_id}");
        UpdateTrafficMirrorFilterRequestBody body = new UpdateTrafficMirrorFilterRequestBody();
        UpdateTrafficMirrorFilterOption trafficMirrorFilterbody = new UpdateTrafficMirrorFilterOption();
        trafficMirrorFilterbody.withDescription("description")
            .withName("test1");
        body.withTrafficMirrorFilter(trafficMirrorFilterbody);
        request.withBody(body);
        try {
            UpdateTrafficMirrorFilterResponse response = client.updateTrafficMirrorFilter(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());
        }
    }
}

Change the name of the traffic mirror filter whose ID is 59d2b2e7-0d35-41f7-a12e-f7699366cd21 to test1.

 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 = UpdateTrafficMirrorFilterRequest()
        request.traffic_mirror_filter_id = "{traffic_mirror_filter_id}"
        trafficMirrorFilterbody = UpdateTrafficMirrorFilterOption(
            description="description",
            name="test1"
        )
        request.body = UpdateTrafficMirrorFilterRequestBody(
            traffic_mirror_filter=trafficMirrorFilterbody
        )
        response = client.update_traffic_mirror_filter(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Change the name of the traffic mirror filter whose ID is 59d2b2e7-0d35-41f7-a12e-f7699366cd21 to test1.

 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.UpdateTrafficMirrorFilterRequest{}
	request.TrafficMirrorFilterId = "{traffic_mirror_filter_id}"
	descriptionTrafficMirrorFilter:= "description"
	nameTrafficMirrorFilter:= "test1"
	trafficMirrorFilterbody := &model.UpdateTrafficMirrorFilterOption{
		Description: &descriptionTrafficMirrorFilter,
		Name: &nameTrafficMirrorFilter,
	}
	request.Body = &model.UpdateTrafficMirrorFilterRequestBody{
		TrafficMirrorFilter: trafficMirrorFilterbody,
	}
	response, err := client.UpdateTrafficMirrorFilter(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.