Querying Network ACLs by Tag
Function
This API is used to query network ACLs by tag.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
vpc:firewalls:listTags
List
firewall *
-
vpc:firewallTags:get
-
URI
POST /v3/{project_id}/firewalls/resource-instances/filter
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | Integer | Definition Number of records returned by a query. Constraints N/A Range 1 to 1000 Default Value 1000 |
| offset | No | Integer | Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints The value must be a non-negative integer. Range N/A Default Value 0: The query starts from the first data record. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| matches | No | Array of Match objects | Definition Search criteria. This parameter specifies the key-value pair to be matched in the query. Constraints Range N/A Default Value N/A |
| tags | No | Array of ListTag objects | Definition Tags. Resources that have the tags specified by tags will be returned. If this parameter is not specified, all resources will be returned. Constraints
Range N/A Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| key | Yes | String | Definition Tag key. Constraints Currently, the key can only be set to resource_name. Range - Letters Default Value N/A |
| value | Yes | String | Definition Tag value. Constraints N/A Range - Letters Default Value N/A |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| key | Yes | String | Definition Tag key. Constraints Currently, the key can only be set to resource_name. Range - Letters Default Value N/A |
| values | Yes | Array of strings | Definition Tag values. Constraints The values are in the OR relationship. Range If values is left empty, it indicates any value. Default Value N/A |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| resources | Array of ListResourceResp objects | Definition Resource list. Range N/A |
| total_count | Integer | Definition Resource quantity. Range N/A |
| request_id | String | Definition Request ID. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| resource_id | String | Resource ID |
| resource_detail | String | Definition Resource details. Range N/A |
| resource_name | String | Definition Resource name. Range N/A |
| tags | Array of ResourceTag objects | Definition Tag list. Range N/A |
| Parameter | Type | Description |
|---|---|---|
| key | String | Definition Tag key. Constraints - Letters Range N/A Default Value N/A |
| value | String | Definition Tag value. Constraints - Letters Range N/A Default Value N/A |
Example Requests
Query network ACLs using tags and matches. A maximum of 100 records can be returned. The query starts from the first record.
https://{Endpoint}/v3/{project_id}/firewalls/resource-instances/filter?limit=100&offset=0
{
"tags" : [ {
"key" : "key1",
"values" : [ "value1" ]
} ],
"matches" : [ {
"key" : "resource_name",
"value" : "network_aclv3_test"
} ]
} Example Responses
Status code: 200
Normal request response. For more status codes, see Status Codes.
{
"resources" : [ {
"resource_id" : "55046c0b-f38e-4bc4-988a-06529b34a7db",
"resource_detail" : "",
"resource_name" : "network_aclv3_test",
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key2",
"value" : "value2"
} ]
}, {
"resource_id" : "1828c600-793d-4570-987b-ac59f3ef0734",
"resource_detail" : "",
"resource_name" : "network_aclv3_test",
"tags" : [ {
"key" : "key1",
"value" : "value1"
}, {
"key" : "key5",
"value" : "value5"
} ]
} ],
"request_id" : "2d9cef8c-4e17-40bc-9111-f3fc97b97294",
"total_count" : 2
} SDK Sample Code
The SDK sample code is as follows.
Query network ACLs using tags and matches. A maximum of 100 records can be returned. The query starts from the first record.
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 60 61 62 63 64 65 66 67 | 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 ListFirewallsByTagsSolution { 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(); ListFirewallsByTagsRequest request = new ListFirewallsByTagsRequest(); ListFirewallsByTagsRequestBody body = new ListFirewallsByTagsRequestBody(); List<String> listTagsValues = new ArrayList<>(); listTagsValues.add("value1"); List<ListTag> listbodyTags = new ArrayList<>(); listbodyTags.add( new ListTag() .withKey("key1") .withValues(listTagsValues) ); List<Match> listbodyMatches = new ArrayList<>(); listbodyMatches.add( new Match() .withKey("resource_name") .withValue("network_aclv3_test") ); body.withTags(listbodyTags); body.withMatches(listbodyMatches); request.withBody(body); try { ListFirewallsByTagsResponse response = client.listFirewallsByTags(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()); } } } |
Query network ACLs using tags and matches. A maximum of 100 records can be returned. The query starts from the first record.
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 | # 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 = ListFirewallsByTagsRequest() listValuesTags = [ "value1" ] listTagsbody = [ ListTag( key="key1", values=listValuesTags ) ] listMatchesbody = [ Match( key="resource_name", value="network_aclv3_test" ) ] request.body = ListFirewallsByTagsRequestBody( tags=listTagsbody, matches=listMatchesbody ) response = client.list_firewalls_by_tags(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Query network ACLs using tags and matches. A maximum of 100 records can be returned. The query starts from the first record.
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 60 61 62 63 64 65 66 67 68 | 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.ListFirewallsByTagsRequest{} var listValuesTags = []string{ "value1", } var listTagsbody = []model.ListTag{ { Key: "key1", Values: listValuesTags, }, } var listMatchesbody = []model.Match{ { Key: "resource_name", Value: "network_aclv3_test", }, } request.Body = &model.ListFirewallsByTagsRequestBody{ Tags: &listTagsbody, Matches: &listMatchesbody, } response, err := client.ListFirewallsByTags(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 | Normal request response. For more status codes, see Status Codes. |
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