Querying Traffic Mirror Filters
Function
This API is used to query information about all traffic mirror filters, including the name and type.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/vpc/traffic-mirror-filters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: ID of the project that a traffic mirror filter belongs to. For details about how to obtain a project ID, see Obtaining a Project ID. Range: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
Array of strings |
Definition: ID of a traffic mirror filter. You can use this field to accurately filter traffic mirror filters. Multiple IDs can be specified for filtering. Range: N/A |
name |
No |
Array of strings |
Definition: Name of a traffic mirror filter. You can use this field to filter traffic mirror filters. Multiple names can be specified for filtering. Range: N/A |
description |
No |
Array of strings |
Definition: Description of a traffic mirror filter. You can use this field to filter traffic mirror filters. Multiple descriptions can be specified for filtering. Range: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
traffic_mirror_filters |
Array of TrafficMirrorFilter objects |
Definition: Response body for querying traffic mirror filters. Range: N/A |
page_info |
PageInfo object |
Definition: Pagination information. Range: N/A |
request_id |
String |
Definition: Request ID. Range: N/A |
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:
|
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:
|
source_cidr_block |
String |
Definition: Source of a traffic mirror filter rule. Range:
|
destination_cidr_block |
String |
Definition: Destination of a traffic mirror filter rule. Range:
|
source_port_range |
String |
Definition: Source port range of a traffic mirror filter rule. Range:
|
destination_port_range |
String |
Definition: Destination port range of a traffic mirror filter rule. Range:
|
ethertype |
String |
Definition: IP address version. Range: IPv4 or IPv6 |
protocol |
String |
Definition: Network protocol type. Range:
|
action |
String |
Definition: Action of a traffic mirror filter rule. Range:
|
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. |
Parameter |
Type |
Description |
---|---|---|
previous_marker |
String |
Definition: The first record on the current page. Range: N/A |
current_count |
Integer |
Definition: Total number of resources on the current page. Range: N/A |
next_marker |
String |
Definition: The last record on the current page. The next_marker field does not exist if the page is the last one. Range: N/A |
Example Requests
Querying traffic mirror filters
GET http://{endpoint}/v3/{project_id}/vpc/traffic-mirror-filters
Example Responses
Status code: 200
OK
{ "request_id" : "05e4a009-74aa-47cb-8055-c3da26a51737", "traffic_mirror_filters" : [ { "id" : "59d2b2e7-0d35-41f7-a12e-f7699366cd21", "project_id" : "49a42f378df747bf8b8f6a70e25b63fb", "name" : "test1", "description" : "new_filter", "ingress_rules" : [ ], "egress_rules" : [ ], "created_at" : "2022-08-29T06:22:01.000+00:00", "updated_at" : "2022-08-29T06:22:01.000+00:00" } ], "page_info" : { "previous_marker" : "180edd76-ab7e-4039-acc2-239ff89243e8", "current_count" : 1 } }
SDK Sample Code
The SDK sample code is as follows.
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 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 ListTrafficMirrorFiltersSolution { 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(); ListTrafficMirrorFiltersRequest request = new ListTrafficMirrorFiltersRequest(); try { ListTrafficMirrorFiltersResponse response = client.listTrafficMirrorFilters(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()); } } } |
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 |
# 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 = ListTrafficMirrorFiltersRequest() response = client.list_traffic_mirror_filters(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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.ListTrafficMirrorFiltersRequest{} response, err := client.ListTrafficMirrorFilters(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