# 通过标签过滤中心网络实例 - ListCentralNetworksByTags #### 功能介绍 通过标签过滤中心网络实例。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/doc?api=ListCentralNetworksByTags&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cc/cc_02_0002.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cc:centralNetwork:list | List | centralNetwork \* | - | - | - | #### URI POST /v3/{domain_id}/gcn/central-networks/filter 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | 用户的账号ID，即租户ID，用于标识资源所属的华为云账号。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | - 参数解释：每页返回的个数，用于控制分页查询返回的记录数量。 - 约束限制：不涉及。 - 取值范围：1\~2000。 - 默认取值：2000。 | | marker | 否 | String | - 参数解释：翻页信息，从上次API调用返回的翻页数据中获取。可填写前一页marker或者后一页marker，填入前一页previous_marker就向前翻页，后一页next_marker就向后翻页。 - 约束限制：翻页过程中，查询条件不能修改，包括过滤条件、排序条件、limit。 - 取值范围：不涉及。 - 默认取值：不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，即用户的认证令牌，用于验证用户身份和权限。 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | tags | 是 | Array of [MultivaluedTag] objects | 包含标签。 | 表5MultivaluedTag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 是 | String | 标签键，最大长度128个unicode字符，格式为大小写字母，数字，中划线"-"，下划线"_"，中文。 | | values | 是 | Array of strings | 相同键的值列表 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求ID。 | | page_info | [PageInfo] object | 分页查询页的信息。 | | central_networks | Array of [CentralNetwork] objects | 中心网络列表。 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 向后分页标识符。 | | previous_marker | String | 向前分页标识符。 | | current_count | Integer | 当前列表中资源数量。 | 表8CentralNetwork | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用标准UUID格式。 - 约束限制：长度为36个字符，符合标准UUID格式，包含4个连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | name | String | - 参数解释：实例名称，用于标识和区分不同的实例。 - 约束限制：长度范围为1\~64个字符，只能由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | description | String | - 参数解释：实例的描述信息，用于记录实例的用途、归属部门等辅助信息。 - 约束限制：长度范围为0\~255个字符，不能包含"\<"和"\>"字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | created_at | String | - 参数解释：实例的创建时间，记录资源首次创建的时间点。 - 约束限制：UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | updated_at | String | - 参数解释：实例的最后更新时间，记录资源最后一次被修改的时间点。 - 约束限制：UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | domain_id | String | 实例所属账号ID。 | | state | String | 中心网络的状态，有效值： - AVAILABLE: 可用 - UPDATING: 处理中 - FAILED: 失败 - CREATING: 创建中 - DELETING: 删除中 - DELETED: 已删除 - RESTORING: 恢复中 | | enterprise_project_id | String | - 参数解释：实例所属的企业项目ID，用于标识资源所属的企业项目，实现企业内部资源的隔离和管理。 - 约束限制：最大长度不超过36字符，符合UUID格式或为字符串"0"。 - 取值范围：不涉及。 - 默认取值："0"表示默认企业项目。 | | 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连接列表。 | 表9Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | - 参数解释：标签键，用于标识和分类资源的标签属性名。 - 约束限制：最大长度128个unicode字符，不能为空，不能以空格开头或结尾，不能以"*sys*"开头。只能包含大小写字母、数字、中划线"-"、下划线"_"、点"."、冒号":"、等号"="、加号"+"、艾特符号"@"、中文字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | value | String | - 参数解释：标签值，与标签键对应的标签属性值，用于提供更具体的资源分类信息。 - 约束限制：最大长度255个unicode字符，可以为空，只能包含大小写字母、数字、中划线"-"、下划线"_"、点"."、冒号":"、等号"="、加号"+"、艾特符号"@"、中文字符、斜杠"/"。 - 取值范围：不涉及。 - 默认取值：不涉及。 | 表10CentralNetworkPlane | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用标准UUID格式。 - 约束限制：长度为36个字符，符合标准UUID格式，包含4个连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | name | String | - 参数解释：实例名称，用于标识和区分不同的实例。 - 约束限制：长度范围为1\~64个字符，只能由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | associate_er_tables | Array of [AssociateErTableDocument] objects | 关联的中心网络ER实例列表。 | | exclude_er_connections | Array of [ExcludeErConnectionDocument] objects | 当自动连接所有ER实例时，排除中心网络的ER实例的连接。 | 表11AssociateErTableDocument | 参数 | 参数类型 | 描述 | |:---|:---|:---| | project_id | String | 实例所属项目ID。 | | region_id | String | RegionID。 | | enterprise_router_id | String | 企业路由器的ID。 | | enterprise_router_table_id | String | 企业路由器的路由表ID。 | 表12ExcludeErConnectionDocument | 参数 | 参数类型 | 描述 | |:---|:---|:---| | \[数组元素\] | Array of [AssociateErInstanceDocument] objects | 中心网络平面管理的ER连接 | 表13AssociateErInstanceDocument | 参数 | 参数类型 | 描述 | |:---|:---|:---| | enterprise_router_id | String | 企业路由器的ID。 | | project_id | String | 实例所属项目ID。 | | region_id | String | RegionID。 | 表14CentralNetworkErInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用标准UUID格式。 - 约束限制：长度为36个字符，符合标准UUID格式，包含4个连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | enterprise_router_id | String | 企业路由器的ID。 | | project_id | String | 实例所属项目ID。 | | region_id | String | RegionID。 | | asn | Long | - 参数解释：网络实例BGP协议的自治系统号（AS号），用于标识网络实例在BGP路由中的身份。 - 约束限制：取值范围为0\~4294967295，必须为有效的AS号。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | site_code | String | 站点编码。 | | state | String | 中心网络ER实例状态，有效值： - AVAILABLE: 可用 - CREATING: 创建中 - UPDATING: 更新中 - DELETING: 删除中 - RECOVERING: 恢复中 - FAILED: 失败 - DELETED: 已删除 | 表15CentralNetworkConnectionInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用标准UUID格式。 - 约束限制：长度为36个字符，符合标准UUID格式，包含4个连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | plane_id | String | 中心网络平面ID。 | | global_connection_bandwidth_id | String | 全域互联带宽ID。 | | bandwidth_size | Integer | 带宽值，单位Mbps。 | | connection_type | String | 中心网络连接类型定义，有效值： - ER-ER: 企业路由器和企业路由器的连接 - ER-GDGW: 企业路由器和全域接入网关附件的连接 - ER-ER_ROUTE_TABLE: 企业路由器和企业路由器路由表附件的连接 | | connection_point_pair | Array of [ConnectionPoint] objects | 中心网络连接的两个端点定义，长度固定为2的数组。 | | state | String | 中心网络连接状态，有效值： - AVAILABLE: 可用 - CREATING: 创建中 - UPDATING: 更新中 - DELETING: 删除中 - FREEZING: 冻结中 - UNFREEZING: 解冻中 - RECOVERING: 恢复中 - FAILED: 失败 - DELETED: 已删除 - APPROVING: 审批中 - APPROVED: 已审批 - UNAPPROVED: 审批未通过 | 表16ConnectionPoint | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用标准UUID格式。 - 约束限制：长度为36个字符，符合标准UUID格式，包含4个连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | project_id | String | 实例所属项目ID。 | | region_id | String | RegionID。 | | site_code | String | 站点编码。 | | instance_id | String | 连接点的实例ID。 | | parent_instance_id | String | 连接点的实例的父资源ID。 | | type | String | 中心网络连接点类型定义，有效值： - ER: 企业路由器 - GDGW: 全域接入网关 - ER_ROUTE_TABLE: ER路由表 | #### 请求示例 通过标签过滤中心网络实例 ``` 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" : "f87a4b574ba18fbc43fcbdccdcdf48944caa", "state" : "AVAILABLE", "enterprise_project_id" : "0" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 通过标签过滤中心网络实例 ``` 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("")) .build(); ListCentralNetworksByTagsRequest request = new ListCentralNetworksByTagsRequest(); ListCentralNetworksByTagsRequestBody body = new ListCentralNetworksByTagsRequestBody(); List listTagsValues = new ArrayList<>(); listTagsValues.add("value"); List 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()); } } } ``` - [Python] 通过标签过滤中心网络实例 ``` # 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("")) \ .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) ``` - [Go] 通过标签过滤中心网络实例 ``` 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("")). 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](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/sdk?api=ListCentralNetworksByTags&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 通过标签过滤中心网络实例成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cc/ErrorCode.html)。