通过标签过滤云连接实例 - ListCloudConnectionsByTags
功能介绍
根据标签键值对过滤查询云连接实例,支持按多个标签进行组合查询。
该接口用于快速查找具有特定标签的云连接实例,便于资源管理和批量操作。
支持精确匹配和模糊匹配,可以同时指定多个标签条件,满足复杂查询需求。
适用于基于标签的资源分组、批量管理和自动化运维场景。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cc:cloudConnections:list
List
cloudConnection *
-
-
-
URI
POST /v3/{domain_id}/ccaas/cloud-connections/filter
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 用户的账号ID,即租户ID,用于标识资源所属的华为云账号。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token,即用户的认证令牌,用于验证用户身份和权限。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| tags | 是 | Array of MultivaluedTag objects | 包含标签。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 请求ID。 |
| page_info | PageInfo object | 分页查询页的信息。 |
| cloud_connections | Array of CloudConnectionInstance objects | 云连接实例列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| next_marker | String | 向后分页标识符。 |
| previous_marker | String | 向前分页标识符。 |
| current_count | Integer | 当前列表中资源数量。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 实例ID。 |
| name | String | |
| description | String | |
| domain_id | String | 实例所属账号ID。 |
| enterprise_project_id | String | |
| created_at | String | |
| updated_at | String | |
| tags | Array of Tag objects | 实例标签。 |
| status | String | 云连接实例的状态,有效值: ACTIVE:状态可用。 |
| admin_state_up | Boolean | 云连接实例的管理状态。 |
| network_instance_number | Integer | 云连接实例关联网络实例的个数。 |
| bandwidth_package_number | Integer | 云连接实例关联带宽包的个数。 |
| inter_region_bandwidth_number | Integer | 云连接实例关联域间带宽的个数。 |
请求示例
通过标签过滤云连接实例
POST https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connections/filter
{
"tags" : [ {
"key" : "department",
"values" : [ "finance" ]
}, {
"key" : "environment",
"values" : [ "production" ]
} ]
} 响应示例
状态码:200
通过标签过滤云连接实例成功。
通过标签过滤云连接实例成功。
{
"request_id" : "ab44eb7776995d84a7580fe6a7bd7629",
"cloud_connections" : [ {
"status" : "ACTIVE",
"id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"name" : "总部云连接",
"description" : "用于连接总部与各分支机构的云连接实例",
"domain_id" : "f87a4b574ba18fbc43fcbdccdcdf48944caa",
"created_at" : "2023-09-20T08:28:28Z",
"updated_at" : "2023-09-20T08:28:28Z",
"admin_state_up" : true,
"enterprise_project_id" : "0",
"tags" : [ {
"key" : "department",
"value" : "finance"
}, {
"key" : "environment",
"value" : "production"
} ]
} ],
"page_info" : {
"previous_marker" : "f4bb2b35-438d-42a1-a281-76f30794a0b0",
"current_count" : 30
}
} SDK代码示例
SDK代码示例如下。
通过标签过滤云连接实例
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 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.cc.v3.region.CcRegion; import com.huaweicloud.sdk.cc.v3.*; import com.huaweicloud.sdk.cc.v3.model.*; import java.util.List; import java.util.ArrayList; public class ListCloudConnectionsByTagsSolution { 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"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CcClient client = CcClient.newBuilder() .withCredential(auth) .withRegion(CcRegion.valueOf("<YOUR REGION>")) .build(); ListCloudConnectionsByTagsRequest request = new ListCloudConnectionsByTagsRequest(); ListCloudConnectionsByTagsRequestBody body = new ListCloudConnectionsByTagsRequestBody(); List<String> listTagsValues = new ArrayList<>(); listTagsValues.add("production"); List<String> listTagsValues1 = new ArrayList<>(); listTagsValues1.add("finance"); List<MultivaluedTag> listbodyTags = new ArrayList<>(); listbodyTags.add( new MultivaluedTag() .withKey("department") .withValues(listTagsValues1) ); listbodyTags.add( new MultivaluedTag() .withKey("environment") .withValues(listTagsValues) ); body.withTags(listbodyTags); request.withBody(body); try { ListCloudConnectionsByTagsResponse response = client.listCloudConnectionsByTags(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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcc.v3.region.cc_region import CcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcc.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"] credentials = GlobalCredentials(ak, sk) client = CcClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListCloudConnectionsByTagsRequest() listValuesTags = [ "production" ] listValuesTags1 = [ "finance" ] listTagsbody = [ MultivaluedTag( key="department", values=listValuesTags1 ), MultivaluedTag( key="environment", values=listValuesTags ) ] request.body = ListCloudConnectionsByTagsRequestBody( tags=listTagsbody ) response = client.list_cloud_connections_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) |
通过标签过滤云连接实例
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 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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") auth, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cc.CcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cc.NewCcClient(hcClient) request := &model.ListCloudConnectionsByTagsRequest{} var listValuesTags = []string{ "production", } var listValuesTags1 = []string{ "finance", } var listTagsbody = []model.MultivaluedTag{ { Key: "department", Values: listValuesTags1, }, { Key: "environment", Values: listValuesTags, }, } request.Body = &model.ListCloudConnectionsByTagsRequestBody{ Tags: listTagsbody, } response, err := client.ListCloudConnectionsByTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 通过标签过滤云连接实例成功。 |
错误码
请参见错误码。