查询中心网络附件列表
功能介绍
查询中心网络附件列表,分页查询使用的参数为marker、limit。limit默认值为0,没有指定marker时返回第一条数据。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v3/{domain_id}/gcn/central-network/{central_network_id}/attachments
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账号ID。 |
central_network_id |
是 |
String |
中心网络的ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页返回的个数。 取值范围:1~1000。 |
marker |
否 |
String |
翻页信息,从上次API调用返回的翻页数据中获取,可填写前一页marker或者后一页marker,填入前一页previous_marker就向前翻页,后一页next_marker就向后翻页。 翻页过程中,查询条件不能修改,包括过滤条件、排序条件、limit。 |
sort_key |
否 |
String |
排序字段。 |
sort_dir |
否 |
Object |
指定排序是升序还是降序(asc为升序,desc为降序)。 |
id |
否 |
Array of arrays |
根据ID查询,可查询多个ID。 |
name |
否 |
Array of strings |
根据名字查询,可查询多个名字。 |
attachment_instance_type |
否 |
Array of arrays |
根据附件类型查询,可查询多个附件类型。 |
state |
否 |
Array of arrays |
根据状态查询,可查询多个状态。 |
attachment_instance_id |
否 |
Array of arrays |
Attachment实例的ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求ID。 |
page_info |
PageInfo object |
分页查询页的信息。 |
central_network_attachments |
Array of CentralNetworkAttachment objects |
接入网络实例连接列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
next_marker |
String |
向后分页标识符。 |
previous_marker |
String |
向前分页标识符。 |
current_count |
Integer |
当前列表中资源数量。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
实例ID。 |
name |
String |
实例名称。 |
description |
String |
实例描述。不支持 <>。 |
domain_id |
String |
实例所属账号ID。 |
state |
String |
中心网络连接状态。
|
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 |
带宽类型包括:
|
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 (路由表)。 |
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 |
附件的额外信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
enterprise_router_table_id |
String |
企业路由器的路由表ID。 |
attachment_parent_instance_id |
String |
连接的父资源ID,这里表示企业路由器ID。 |
hosted_cloud |
String |
|
approved_state |
String |
审批状态。
|
reason |
String |
审批拒绝创建附件的原因。 |
请求示例
查询中心网络附件列表
GET /v3/{domain_id}/gcn/central-network/{central_network_id}/attachments
响应示例
状态码: 200
查询接入网络实例连接列表成功。
{ "request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "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" : "XXX", "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" : "XXX", "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" : "XXX", "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", "approved_state" : "APPROVING", "hosted_cloud" : "HWCloud", "reason" : "string" } } ] }
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 |
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("<YOUR REGION>")) .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()); } } } |
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 |
# 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 = 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) |
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 |
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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cc.NewCcClient( cc.CcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) 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的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询接入网络实例连接列表成功。 |
错误码
请参见错误码。