Querying the Number of Ports Using Tags
Function
This API is used to query the number of ports using tags. This API is available only in the CN South-Shenzhen region.
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:ports:listTags
List
port *
-
- vpc:portTags:get
-
URI
POST /v3/{project_id}/ports/resource-instances/count
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
matches |
No |
Array of Match objects |
The key-value pair to be matched in the query. The key is a fixed dictionary value and must be a unique and supported key. The key can only be resource_name. |
|
tags |
No |
Array of ListTag objects |
The resources to be queried contain all tags listed in tags. A maximum of 50 tags can be specified. Each tag key can have a maximum of 10 tag values. Each tag value can be an empty array but the structure cannot be missing. Each tag key must be unique, and each tag value of a tag must also be unique. Resources with all tags listed in tags will be returned. Keys in this list are in an AND relationship while values in each key-value structure are in an OR relationship. If tags is not specified, all resources will be returned. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
Request ID |
|
total_count |
Integer |
Resource quantity |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
|
|
error_msg |
String |
|
|
error_code |
String |
|
Example Requests
Query ports using tags and matches.
POST https://{{Endpoint}}/v3/{project_id}/ports/resource-instances/count
{
"tags" : [ {
"key" : "key1",
"values" : [ "value1" ]
} ],
"matches" : [ {
"key" : "resource_name",
"value" : "portv3_test"
} ]
}
Example Responses
Status code: 200
Normal request response.
{
"request_id" : "239df34e-a651-4631-aaa1-d5fef231933a",
"total_count" : 2
}
SDK Sample Code
The SDK sample code is as follows.
Query ports using tags and matches.
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 CountPortsByTagsSolution { 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(); CountPortsByTagsRequest request = new CountPortsByTagsRequest(); CountPortsByTagsRequestBody body = new CountPortsByTagsRequestBody(); 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("portv3_test") ); body.withTags(listbodyTags); body.withMatches(listbodyMatches); request.withBody(body); try { CountPortsByTagsResponse response = client.countPortsByTags(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 ports using tags and matches.
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 = CountPortsByTagsRequest() listValuesTags = [ "value1" ] listTagsbody = [ ListTag( key="key1", values=listValuesTags ) ] listMatchesbody = [ Match( key="resource_name", value="portv3_test" ) ] request.body = CountPortsByTagsRequestBody( tags=listTagsbody, matches=listMatchesbody ) response = client.count_ports_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 ports using tags and matches.
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 |
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.CountPortsByTagsRequest{} var listValuesTags = []string{ "value1", } var listTagsbody = []model.ListTag{ { Key: "key1", Values: listValuesTags, }, } var listMatchesbody = []model.Match{ { Key: "resource_name", Value: "portv3_test", }, } request.Body = &model.CountPortsByTagsRequestBody{ Tags: &listTagsbody, Matches: &listMatchesbody, } response, err := client.CountPortsByTags(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. |
|
400 |
Invalid parameter. |
|
401 |
Authentication failure. |
|
403 |
Insufficient permissions. |
|
404 |
Not found. |
|
500 |
System exception. |
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