Updating a Traffic Mirror Session
Function
This API is used to update a traffic mirror session.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/vpc/traffic-mirror-sessions/{traffic_mirror_session_id}
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
traffic_mirror_session |
Yes |
Traffic mirror session. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Traffic mirror session name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
description |
No |
String |
Description of a traffic mirror session. The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
traffic_mirror_filter_id |
No |
String |
Traffic mirror filter ID. |
traffic_mirror_target_id |
No |
String |
Mirror target ID. |
traffic_mirror_target_type |
No |
String |
Mirror target type. The value can be eni (elastic network interface) or elb (private network load balancer). |
virtual_network_id |
No |
Integer |
VNI, which is used to distinguish mirrored traffic of different sessions for a mirror target. Value range: 0-16777215 |
packet_length |
No |
Integer |
Maximum transmission unit (MTU). Value range: 1-1460 |
priority |
No |
Integer |
Mirror session priority. Value range: 1-32766 |
enabled |
No |
String |
Whether to enable a mirror session. The value can be true or false. |
Response Parameters
Status code: 200
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 |
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:
|
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:
|
type |
String |
Definition: Type of the traffic mirror source that a traffic mirror session is associated with. Range:
|
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
Update the traffic mirror session with ID of 16538eda-7e94-4b90-b5f3-a653f62dc817, mirror target type of elb, and mirror target ID of 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" } }
Example Responses
Status code: 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 Sample Code
The SDK sample code is as follows.
Update the traffic mirror session with ID of 16538eda-7e94-4b90-b5f3-a653f62dc817, mirror target type of elb, and mirror target ID of 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()); } } } |
Update the traffic mirror session with ID of 16538eda-7e94-4b90-b5f3-a653f62dc817, mirror target type of elb, and mirror target ID of 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) |
Update the traffic mirror session with ID of 16538eda-7e94-4b90-b5f3-a653f62dc817, mirror target type of elb, and mirror target ID of 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) } } |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot