查询端口资源实例数量
功能介绍
使用标签过滤查询端口实例数量。
该接口在华南-深圳上线。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/ports/resource-instances/count
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 获取方式请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
matches |
否 |
Array of Match objects |
功能说明:搜索字段,key为要匹配的字段,value为匹配的值 约束:key为固定字典值,不能包含重复的key或不支持的key,当前key仅支持resource_name |
tags |
否 |
Array of ListTag objects |
包含标签,最多包含50个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失 。 Key不能重复,同一个key中values不能重复。 结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求ID |
total_count |
Integer |
资源数量 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
|
error_msg |
String |
|
error_code |
String |
|
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
|
error_msg |
String |
|
error_code |
String |
|
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
|
error_msg |
String |
|
error_code |
String |
|
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
|
error_msg |
String |
|
error_code |
String |
|
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
|
error_msg |
String |
|
error_code |
String |
|
请求示例
过滤查询端口资源实例数量,用tags和matches过滤。
POST https://{{Endpoint}}/v3/{project_id}/ports/resource-instances/count { "tags" : [ { "key" : "key1", "values" : [ "value1" ] } ], "matches" : [ { "key" : "resource_name", "value" : "portv3_test" } ] }
响应示例
状态码:200
请求正常返回。
{ "request_id" : "239df34e-a651-4631-aaa1-d5fef231933a", "total_count" : 2 }
SDK代码示例
SDK代码示例如下。
过滤查询端口资源实例数量,用tags和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()); } } } |
过滤查询端口资源实例数量,用tags和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) |
过滤查询端口资源实例数量,用tags和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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求正常返回。 |
400 |
参数非法。 |
401 |
鉴权失败。 |
403 |
权限不足。 |
404 |
资源未找到。 |
500 |
系统异常。 |
错误码
请参见错误码。