通过标签过滤中心网络实例 - ListCentralNetworksByTags
功能介绍
通过标签过滤中心网络实例。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
cc:centralNetwork:list
List
centralNetwork *
-
-
-
URI
POST /v3/{domain_id}/gcn/central-networks/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 | 分页查询页的信息。 |
| central_networks | Array of CentralNetwork objects | 中心网络列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| next_marker | String | 向后分页标识符。 |
| previous_marker | String | 向前分页标识符。 |
| current_count | Integer | 当前列表中资源数量。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | |
| name | String | |
| description | String | |
| created_at | String | |
| updated_at | String | |
| domain_id | String | 实例所属账号ID。 |
| state | String | 中心网络的状态,有效值: |
| enterprise_project_id | String | |
| tags | Array of Tag objects | 实例标签。 |
| default_plane_id | String | 中心网络默认平面的ID。 |
| planes | Array of CentralNetworkPlane objects | 中心网络平面列表。 |
| er_instances | Array of CentralNetworkErInstance objects | 中心网络ER实例列表。 |
| connections | Array of CentralNetworkConnectionInfo objects | 中心网络ER连接列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | |
| name | String | |
| associate_er_tables | Array of AssociateErTableDocument objects | 关联的中心网络ER实例列表。 |
| exclude_er_connections | Array of ExcludeErConnectionDocument objects | 当自动连接所有ER实例时,排除中心网络的ER实例的连接。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| project_id | String | 实例所属项目ID。 |
| region_id | String | RegionID。 |
| enterprise_router_id | String | 企业路由器的ID。 |
| enterprise_router_table_id | String | 企业路由器的路由表ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| [数组元素] | Array of AssociateErInstanceDocument objects | 中心网络平面管理的ER连接 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enterprise_router_id | String | 企业路由器的ID。 |
| project_id | String | 实例所属项目ID。 |
| region_id | String | RegionID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | |
| enterprise_router_id | String | 企业路由器的ID。 |
| project_id | String | 实例所属项目ID。 |
| region_id | String | RegionID。 |
| asn | Long | |
| site_code | String | 站点编码。 |
| state | String | 中心网络ER实例状态,有效值: |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | |
| plane_id | String | 中心网络平面ID。 |
| global_connection_bandwidth_id | String | 全域互联带宽ID。 |
| bandwidth_size | Integer | 带宽值,单位Mbps。 |
| connection_type | String | 中心网络连接类型定义,有效值: |
| connection_point_pair | Array of ConnectionPoint objects | 中心网络连接的两个端点定义,长度固定为2的数组。 |
| state | String | 中心网络连接状态,有效值: |
请求示例
通过标签过滤中心网络实例
POST https://{cc_endpoint}/v3/{domain_id}/gcn/central-networks/filter
{
"tags" : [ {
"key" : "key",
"values" : [ "value" ]
} ]
} 响应示例
状态码:200
通过标签过滤中心网络实例成功。
{
"request_id" : "0b6ba65808f9d7277f916d44845d271c",
"page_info" : {
"current_count" : 1
},
"central_networks" : [ {
"id" : "e096c86f-817c-418c-945c-6b1d8860a15d",
"name" : "name",
"created_at" : "2023-10-09T06:22:40.856Z",
"updated_at" : "2023-10-09T06:22:40.856Z",
"domain_id" : "XXX",
"state" : "AVAILABLE",
"enterprise_project_id" : "0"
} ]
} 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 | 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 ListCentralNetworksByTagsSolution { 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(); ListCentralNetworksByTagsRequest request = new ListCentralNetworksByTagsRequest(); ListCentralNetworksByTagsRequestBody body = new ListCentralNetworksByTagsRequestBody(); List<String> listTagsValues = new ArrayList<>(); listTagsValues.add("value"); List<MultivaluedTag> listbodyTags = new ArrayList<>(); listbodyTags.add( new MultivaluedTag() .withKey("key") .withValues(listTagsValues) ); body.withTags(listbodyTags); request.withBody(body); try { ListCentralNetworksByTagsResponse response = client.listCentralNetworksByTags(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 | # 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 = ListCentralNetworksByTagsRequest() listValuesTags = [ "value" ] listTagsbody = [ MultivaluedTag( key="key", values=listValuesTags ) ] request.body = ListCentralNetworksByTagsRequestBody( tags=listTagsbody ) response = client.list_central_networks_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 | 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.ListCentralNetworksByTagsRequest{} var listValuesTags = []string{ "value", } var listTagsbody = []model.MultivaluedTag{ { Key: "key", Values: listValuesTags, }, } request.Body = &model.ListCentralNetworksByTagsRequestBody{ Tags: listTagsbody, } response, err := client.ListCentralNetworksByTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 通过标签过滤中心网络实例成功。 |
错误码
请参见错误码。