查询中心网络列表
功能介绍
查询中心网络列表。 分页查询使用的参数为marker、limit。limit默认值为0,没有指定marker时返回第一条数据。
调用方法
请参见如何调用API。
URI
GET /v3/{domain_id}/gcn/central-networks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账户ID。 最小长度:10 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页返回的个数。 取值范围:1~1000。 最小值:1 最大值:1000 缺省值:1000 |
marker |
否 |
String |
翻页信息,从上次API调用返回的翻页数据中获取,可填写前一页marker或者后一页marker,填入前一页previous_marker就向前翻页,后一页next_marker就向翻页。 翻页过程中,查询条件不能修改,包括过滤条件,排序条件,limit。 最小长度:1 最大长度:4096 |
sort_key |
否 |
String |
排序字段。 缺省值:updated_at 最小长度:1 最大长度:36 |
sort_dir |
否 |
Object |
指定排序是升序还是降序(asc为升序,desc为降序)。 |
id |
否 |
Array |
根据id查询,可查询多个id。 数组长度:1 - 20 |
name |
否 |
Array |
根据名字查询,可查询多个名字。 数组长度:1 - 20 |
state |
否 |
Array |
根据状态查询,可查询多个状态。 数组长度:1 - 20 |
enterprise_project_id |
否 |
Array |
根据企业项目ID过滤列表。 数组长度:1 - 20 |
enterprise_router_id |
否 |
Array |
根据ER实例ID过滤列表。 数组长度:1 - 10 |
attachment_instance_id |
否 |
Array |
Attachment实例的ID。 数组长度:1 - 10 |
global_connection_bandwidth_id |
否 |
Array |
根据带宽包ID过滤。 数组长度:1 - 20 |
connection_id |
否 |
Array |
连接的ID。 数组长度:1 - 10 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 最小长度:0 最大长度:2000000 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
资源ID标识符。 最小长度:32 最大长度:36 |
page_info |
PageInfo object |
分页查询页的信息。 |
central_networks |
Array of CentralNetwork objects |
中心网络列表。 数组长度:0 - 2000 |
参数 |
参数类型 |
描述 |
---|---|---|
next_marker |
String |
向后分页标识符。 最小长度:1 最大长度:4096 |
previous_marker |
String |
向前分页标识符。 最小长度:1 最大长度:4096 |
current_count |
Integer |
当前列表中资源数量。 最小值:0 最大值:2000 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
资源ID标识符。 |
name |
String |
实例名字。 |
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 |
中心网络状态。
|
enterprise_project_id |
String |
实例所属企业项目ID。 最小长度:1 最大长度:36 |
tags |
Array of Tag objects |
实例标签。 数组长度:1 - 20 |
planes |
Array of CentralNetworkPlane objects |
中心网平面列表。 数组长度:0 - 2000 |
er_instances |
Array of CentralNetworkErInstance objects |
中心网ER实例列表。 数组长度:1 - 200 |
connections |
Array of CentralNetworkConnectionInfo objects |
中心网ER连接列表。 数组长度:0 - 2000 |
default_plane_id |
String |
资源ID标识符。 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
标签键,最大长度128个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。 |
value |
String |
标签值,最大长度255个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
资源ID标识符。 |
name |
String |
实例名字。 |
associate_er_tables |
Array of AssociateErTableDocument objects |
关联的中心网络ER实例列表。 数组长度:0 - 100 |
exclude_er_connections |
Array of ExcludeErConnectionDocument objects |
当自动连接所有ER实例时,排除中心网络的ER实例的连接。 数组长度:0 - 100 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
资源ID标识符。 |
enterprise_router_id |
String |
企业路由器的ID。 |
project_id |
String |
实例所属项目ID。 |
region_id |
String |
RegionID。 |
asn |
Long |
网络实例BGP协议的AS号。 最小值:0 最大值:4294967295 |
site_code |
String |
站点编码定义 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
资源ID标识符。 |
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的数组。 数组长度:2 - 2 |
state |
String |
中心网络连接状态。
|
请求示例
查询中心网络
GET /v3/{domain_id}/gcn/central-networks
响应示例
状态码: 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 59 |
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 ListCentralNetworksSolution { 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(); ListCentralNetworksRequest request = new ListCentralNetworksRequest(); request.withLimit(<limit>); request.withMarker("<marker>"); request.withSortKey("<sort_key>"); request.withSortDir(); request.withId(); request.withName(); request.withState(); request.withEnterpriseProjectId(); request.withEnterpriseRouterId(); request.withAttachmentInstanceId(); request.withGlobalConnectionBandwidthId(); request.withConnectionId(); try { ListCentralNetworksResponse response = client.listCentralNetworks(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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = GlobalCredentials(ak, sk) \ client = CcClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListCentralNetworksRequest() request.limit = <limit> request.marker = "<marker>" request.sort_key = "<sort_key>" request.sort_dir = request.id = request.name = request.state = request.enterprise_project_id = request.enterprise_router_id = request.attachment_instance_id = request.global_connection_bandwidth_id = request.connection_id = response = client.list_central_networks(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 |
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.ListCentralNetworksRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest sortKeyRequest:= "<sort_key>" request.SortKey = &sortKeyRequest response, err := client.ListCentralNetworks(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询中心网络列表成功。 |
错误码
请参见错误码。