# 查询中心网络附件列表 - ListCentralNetworkAttachments #### 功能介绍 查询中心网络附件列表，分页查询使用的参数为marker、limit。limit默认值为0，没有指定marker时返回第一条数据。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CC/doc?api=ListCentralNetworkAttachments&version=v3)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cc/cc_02_0002.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cc:centralNetworkAttachment:list | List | centralNetworkAttachment \* | - | - | - | | cc:centralNetworkAttachment:list | List | centralNetwork \* | g:ResourceTag/\ | - | - | | cc:centralNetworkAttachment:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v3/{domain_id}/gcn/central-network/{central_network_id}/attachments 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | 用户的账号ID，即租户ID，用于标识资源所属的华为云账号。 | | central_network_id | 是 | String | 中心网络的ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | - 参数解释：每页返回的个数，用于控制分页查询返回的记录数量。 - 约束限制：不涉及。 - 取值范围：1\~2000。 - 默认取值：2000。 | | marker | 否 | String | - 参数解释：翻页信息，从上次API调用返回的翻页数据中获取。可填写前一页marker或者后一页marker，填入前一页previous_marker就向前翻页，后一页next_marker就向后翻页。 - 约束限制：翻页过程中，查询条件不能修改，包括过滤条件、排序条件、limit。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | sort_dir | 否 | Object | - 参数解释：排序方向，用于指定查询结果的排序顺序。 - 约束限制：不涉及。 - 取值范围： - asc: 升序，从小到大排序 - desc: 降序，从大到小排序 - 默认取值：不涉及。 | | id | 否 | Array of strings | 根据ID查询，可查询多个ID。 | | name | 否 | Array of strings | 根据名称查询，可查询多个名称。 | | attachment_instance_type | 否 | Array of strings | 根据附件类型查询附件。类型有效值： - GDGW: 全域接入网关 - ER_ROUTE_TABLE: ER路由表 | | state | 否 | Array of strings | 根据状态查询，有效值： - AVAILABLE: 可用 - CREATING: 创建中 - UPDATING: 更新中 - DELETING: 删除中 - FREEZING: 冻结中 - UNFREEZING: 解冻中 - RECOVERING: 恢复中 - FAILED: 失败 - DELETED: 已删除 - APPROVING: 审批中 - APPROVED: 已审批 - UNAPPROVED: 审批未通过 | | attachment_instance_id | 否 | Array of strings | Attachment实例的ID。 | | enterprise_project_id | 否 | Array of strings | 根据企业项目ID过滤列表。 | | sort_key | 否 | String | 排序字段，有效值： - id: 附件ID。 - created_at: 创建时间。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | 用户Token，即用户的认证令牌，用于验证用户身份和权限。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求ID。 | | page_info | [PageInfo] object | 分页查询页的信息。 | | central_network_attachments | Array of [CentralNetworkAttachment] objects | 接入网络实例连接列表。 | 表5PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 向后分页标识符。 | | previous_marker | String | 向前分页标识符。 | | current_count | Integer | 当前列表中资源数量。 | 表6CentralNetworkAttachment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | - 参数解释：实例ID，即资源的唯一标识符，采用标准UUID格式。 - 约束限制：长度为36个字符，符合标准UUID格式，包含4个连字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | name | String | - 参数解释：实例名称，用于标识和区分不同的实例。 - 约束限制：长度范围为1\~64个字符，只能由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | description | String | - 参数解释：实例的描述信息，用于记录实例的用途、归属部门等辅助信息。 - 约束限制：长度范围为0\~255个字符，不能包含"\<"和"\>"字符。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | domain_id | String | 实例所属账号ID。 | | state | String | 中心网络连接状态，有效值： - AVAILABLE: 可用 - CREATING: 创建中 - UPDATING: 更新中 - DELETING: 删除中 - FREEZING: 冻结中 - UNFREEZING: 解冻中 - RECOVERING: 恢复中 - FAILED: 失败 - DELETED: 已删除 - APPROVING: 审批中 - APPROVED: 已审批 - UNAPPROVED: 审批未通过 | | created_at | String | - 参数解释：实例的创建时间，记录资源首次创建的时间点。 - 约束限制：UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | updated_at | String | - 参数解释：实例的最后更新时间，记录资源最后一次被修改的时间点。 - 约束限制：UTC时间格式，yyyy-MM-ddTHH:mm:ss。 | | central_network_id | String | 中心网络ID。 | | central_network_plane_id | String | 中心网络平面ID。 | | global_connection_bandwidth_id | String | 全域互联带宽ID。 | | bandwidth_type | String | 带宽类型包括，有效值： - BandwidthPackage: 按带宽计费，需要绑定全域互联带宽，并指定分配带宽大小 - TestBandwidth: 不收费的测试带宽，仅保留最小带宽，用于测试跨地域连通性 | | bandwidth_size | Integer | 带宽值，单位Mbps。 | | is_frozen | Boolean | 是否冻结。 | | enterprise_router_id | String | 企业路由器的ID。 | | enterprise_router_project_id | String | 企业路由器的项目ID。 | | enterprise_router_region_id | String | ER路由器的regionID。 | | enterprise_router_attachment_id | String | 企业路由器的连接ID。 | | attachment_instance_type | String | 附件类型，有效值： - GDGW: 全域接入网关 - ER_ROUTE_TABLE: ER路由表 | | attachment_instance_id | String | 中心网络附件对端实例ID，企业路由器的路由表ID或者GDGW的ID。 | | attachment_id | String | 中心网络附件对端实例的连接ID，企业路由器的连接ID或者GDGW的连接ID。 | | attachment_instance_project_id | String | 中心网络附件对端实例的项目ID。 | | attachment_instance_region_id | String | 中心网络附件对端实例的regionID。 | | attachment_instance_site_code | String | 中心网络附件对端实例的站点编码。 | | enterprise_router_site_code | String | 中心网络企业路由器的站点编码。 | | specification_value | [CentralNetworkAttachmentSpecificationValueInfo] object | 附件的额外信息。 | 表7CentralNetworkAttachmentSpecificationValueInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | enterprise_router_table_id | String | 企业路由器的路由表ID。 | | attachment_parent_instance_id | String | 连接的父资源ID，这里表示企业路由器ID。 | | hosted_cloud | String | 归属云，有效值： - HWCloud: 华为云 - Ireland: 爱尔兰 | | approved_state | String | 审批状态，有效值： - APPROVING: 审批中 - APPROVED: 已审批 - UNAPPROVED: 审批未通过 | | reason | String | 审批拒绝创建附件的原因。 | #### 请求示例 查询中心网络附件列表 ``` GET /v3/{domain_id}/gcn/central-network/{central_network_id}/attachments ``` #### 响应示例 **状态码：200** 查询接入网络实例连接列表成功。 ``` { "request_id" : "a3bad42033b84e269e9bbdf67aa8e72b", "page_info" : { "next_marker" : "8EDF12u71N...", "previous_marker" : "8EDF12u71N...", "current_count" : 1 }, "central_network_attachments" : [ { "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "name" : "name", "description" : "description", "domain_id" : "f87a4b574ba18fbc43fcbdccdcdf48944caa", "state" : "AVAILABLE", "created_at" : "2023-10-09T10:13:57.962Z", "updated_at" : "2023-10-09T10:13:57.962Z", "central_network_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "central_network_plane_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "bandwidth_type" : "BandwidthPackage", "bandwidth_size" : 20, "is_frozen" : false, "enterprise_router_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "enterprise_router_project_id" : "2b20c49c4c6d4eefb7b7c7c7c7c7c7c7", "enterprise_router_region_id" : "region-abc", "enterprise_router_attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "attachment_instance_type" : "GDGW", "attachment_instance_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "attachment_instance_project_id" : "2b20c49c4c6d4eefb7b7c7c7c7c7c7c7", "attachment_instance_region_id" : "region-abc", "attachment_instance_site_code" : "site-abc", "enterprise_router_site_code" : "site-abc", "specification_value" : { "enterprise_router_table_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "attachment_parent_instance_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "approved_state" : "APPROVING", "hosted_cloud" : "HWCloud", "reason" : "string" } } ] } ``` #### 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.*; public class ListCentralNetworkAttachmentsSolution { 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(); ListCentralNetworkAttachmentsRequest request = new ListCentralNetworkAttachmentsRequest(); request.withCentralNetworkId("{central_network_id}"); try { ListCentralNetworkAttachmentsResponse response = client.listCentralNetworkAttachments(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 = ListCentralNetworkAttachmentsRequest() request.central_network_id = "{central_network_id}" response = client.list_central_network_attachments(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.ListCentralNetworkAttachmentsRequest{} request.CentralNetworkId = "{central_network_id}" response, err := client.ListCentralNetworkAttachments(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=ListCentralNetworkAttachments&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询接入网络实例连接列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cc/ErrorCode.html)。