添加流量镜像会话的镜像源 - AddSourcesToTrafficMirrorSession
功能介绍
在流量镜像会话中,添加镜像源。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
PUT /v3/{project_id}/vpc/traffic-mirror-sessions/{traffic_mirror_session_id}/add-sources
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 流量镜像会话所属的项目ID。获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| traffic_mirror_session_id | 是 | String | 参数解释: 流量镜像会话ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| traffic_mirror_session | 是 | TrafficMirrorSourcesOption object | 参数解释: 流量镜像会话对象。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| traffic_mirror_session | TrafficMirrorSession object | 参数解释: 查询流量镜像会话详情的响应体。 取值范围: 不涉及。 |
| request_id | String | 参数解释: 请求ID。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| 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 | 参数解释: 流量镜像会话关联的镜像目的的类型。 取值范围: |
| virtual_network_id | Integer | 参数解释: 指定VNI :VXLAN网络标识(VXLAN Network Identifier),简称为VNI。 由于一个镜像目的可以被关联至多个镜像会话,因此对于镜像目的来说,VNI用来区分不同的镜像会话。 取值范围: 0~16777215 |
| packet_length | Integer | 参数解释: 镜像报文长度,表示符合筛选条件,被镜像的报文长度。 约束限制: 不涉及。 取值范围: 1~1460 bytes 默认取值: 96 bytes |
| priority | Integer | 参数解释: 镜像会话优先级。 取值范围: 1~32766,数字越小,表示优先级越高。 |
| enabled | Boolean | 参数解释: 是否开启流量镜像会话。 取值范围: |
| type | String | 参数解释: 流量镜像会话的镜像源的类型。 取值范围: |
| created_at | String | 参数解释: 流量镜像会话的创建时间。 取值范围: 不涉及。 |
| updated_at | String | 参数解释: 流量镜像会话的更新时间。 取值范围: 不涉及。 |
请求示例
添加镜像源6134900d-31a6-4b71-8453-dbca7f26982e到镜像会话e15a6e40-2580-4949-bf2a-55ee7cd49392中。
PUT https://{endpoint}/v3/{project_id}/vpc/traffic-mirror-sessions/e15a6e40-2580-4949-bf2a-55ee7cd49392/add-sources
{
"traffic_mirror_session" : {
"traffic_mirror_sources" : [ "6134900d-31a6-4b71-8453-dbca7f26982e" ]
}
} 响应示例
状态码:200
PUT操作正常返回,更多状态码请参见状态码。
{
"traffic_mirror_session" : {
"name" : "test-session",
"created_at" : "2023-02-23T06:57:39Z",
"updated_at" : "2023-02-23T06:57:39Z",
"id" : "e15a6e40-2580-4949-bf2a-55ee7cd49392",
"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" : "1adbc9b3-df85-4343-948a-d129536fa309",
"traffic_mirror_target_type" : "eni",
"virtual_network_id" : 1,
"packet_length" : 96,
"priority" : 6,
"enabled" : true,
"type" : "eni"
},
"request_id" : "be17b2e9-098c-4b56-ac0c-97e6b6413f12"
} SDK代码示例
SDK代码示例如下。
添加镜像源6134900d-31a6-4b71-8453-dbca7f26982e到镜像会话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 AddSourcesToTrafficMirrorSessionSolution { 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(); AddSourcesToTrafficMirrorSessionRequest request = new AddSourcesToTrafficMirrorSessionRequest(); request.withTrafficMirrorSessionId("{traffic_mirror_session_id}"); AddSourcesToTrafficMirrorSessionRequestBody body = new AddSourcesToTrafficMirrorSessionRequestBody(); List<String> listTrafficMirrorSessionTrafficMirrorSources = new ArrayList<>(); listTrafficMirrorSessionTrafficMirrorSources.add("6134900d-31a6-4b71-8453-dbca7f26982e"); TrafficMirrorSourcesOption trafficMirrorSessionbody = new TrafficMirrorSourcesOption(); trafficMirrorSessionbody.withTrafficMirrorSources(listTrafficMirrorSessionTrafficMirrorSources); body.withTrafficMirrorSession(trafficMirrorSessionbody); request.withBody(body); try { AddSourcesToTrafficMirrorSessionResponse response = client.addSourcesToTrafficMirrorSession(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()); } } } |
添加镜像源6134900d-31a6-4b71-8453-dbca7f26982e到镜像会话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 = AddSourcesToTrafficMirrorSessionRequest() request.traffic_mirror_session_id = "{traffic_mirror_session_id}" listTrafficMirrorSourcesTrafficMirrorSession = [ "6134900d-31a6-4b71-8453-dbca7f26982e" ] trafficMirrorSessionbody = TrafficMirrorSourcesOption( traffic_mirror_sources=listTrafficMirrorSourcesTrafficMirrorSession ) request.body = AddSourcesToTrafficMirrorSessionRequestBody( traffic_mirror_session=trafficMirrorSessionbody ) response = client.add_sources_to_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) |
添加镜像源6134900d-31a6-4b71-8453-dbca7f26982e到镜像会话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 58 59 | 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("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := vpc.NewVpcClient(hcClient) request := &model.AddSourcesToTrafficMirrorSessionRequest{} request.TrafficMirrorSessionId = "{traffic_mirror_session_id}" var listTrafficMirrorSourcesTrafficMirrorSession = []string{ "6134900d-31a6-4b71-8453-dbca7f26982e", } trafficMirrorSessionbody := &model.TrafficMirrorSourcesOption{ TrafficMirrorSources: listTrafficMirrorSourcesTrafficMirrorSession, } request.Body = &model.AddSourcesToTrafficMirrorSessionRequestBody{ TrafficMirrorSession: trafficMirrorSessionbody, } response, err := client.AddSourcesToTrafficMirrorSession(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | PUT操作正常返回,更多状态码请参见状态码。 |
错误码
请参见错误码。