Querying the Central Network List
Function
This API is used to query the central network list.
Parameters marker and limit are used for pagination query. The default value of limit is 0. If marker is not specified, the first data record is returned.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{domain_id}/gcn/central-networks
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. Minimum: 10 Maximum: 32 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records on each page. Value range: 1 to 1000 Minimum: 1 Maximum: 1000 Default: 1000 |
marker |
No |
String |
Pagination query information. You can obtain the marker values from the response of the last API call. You can enter the marker value of the previous page or the next page. If you enter the marker value of the previous page, the previous page will be queried. If you enter the marker value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the limit value, cannot be modified. Minimum: 1 Maximum: 4096 |
sort_key |
No |
String |
Field for sorting. Default: updated_at Minimum: 1 Maximum: 36 |
sort_dir |
No |
Object |
Whether the resources are sorted in ascending or descending order. asc indicates the ascending order and desc indicates the descending order. |
id |
No |
Array |
Resource ID. Multiple IDs can be queried. Array Length: 1 - 20 |
name |
No |
Array |
Resource name. Multiple names can be queried. Array Length: 1 - 20 |
state |
No |
Array |
Central network status. Multiple statuses can be queried. Array Length: 1 - 20 |
enterprise_project_id |
No |
Array |
Enterprise project IDs. Array Length: 1 - 20 |
enterprise_router_id |
No |
Array |
Enterprise router IDs. Array Length: 1 - 10 |
attachment_instance_id |
No |
Array |
Attachment ID. Array Length: 1 - 10 |
global_connection_bandwidth_id |
No |
Array |
Bandwidth package IDs. Array Length: 1 - 20 |
connection_id |
No |
Array |
Connection ID. Array Length: 1 - 10 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. Minimum: 0 Maximum: 2000000 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Resource ID. Minimum: 32 Maximum: 36 |
page_info |
PageInfo object |
Pagination query information. |
central_networks |
Array of CentralNetwork objects |
Central network list. Array Length: 0 - 2000 |
Parameter |
Type |
Description |
---|---|---|
next_marker |
String |
Backward pagination identifier. Minimum: 1 Maximum: 4096 |
previous_marker |
String |
Forward pagination identifier. Minimum: 1 Maximum: 4096 |
current_count |
Integer |
Number of the resources in the current list. Minimum: 0 Maximum: 2000 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Resource ID. |
name |
String |
Resource name. |
description |
String |
Resource description. Angle brackets (<>) are not allowed. Minimum: 0 Maximum: 255 |
created_at |
String |
Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format. |
updated_at |
String |
Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format. |
domain_id |
String |
ID of the account that the instance belongs to. |
state |
String |
Central network status.
|
enterprise_project_id |
String |
ID of the enterprise project that the virtual gateway belongs to. Minimum: 1 Maximum: 36 |
tags |
Array of Tag objects |
Resource tags. Array Length: 1 - 20 |
planes |
Array of CentralNetworkPlane objects |
List of central network planes. Array Length: 0 - 2000 |
er_instances |
Array of CentralNetworkErInstance objects |
List of enterprise routers on a central network. Array Length: 1 - 200 |
connections |
Array of CentralNetworkConnectionInfo objects |
List of the enterprise router connections on a central network. Array Length: 0 - 2000 |
default_plane_id |
String |
Resource ID. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. The key can contain a maximum of 128 Unicode characters, including letters, digits, hyphens (-), and underscores (_). |
value |
String |
Tag value. The value can contain a maximum of 255 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.). |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Resource ID. |
name |
String |
Resource name. |
associate_er_tables |
Array of AssociateErTableDocument objects |
List of the enterprise routers on the central network. Array Length: 0 - 100 |
exclude_er_connections |
Array of ExcludeErConnectionDocument objects |
Whether to exclude the connections to enterprise routers on the central network. Array Length: 0 - 100 |
Parameter |
Type |
Description |
---|---|---|
project_id |
String |
Project ID. |
region_id |
String |
Region ID. |
enterprise_router_id |
String |
Enterprise router ID. |
enterprise_router_table_id |
String |
Resource ID. |
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of AssociateErInstanceDocument objects |
Connections between enterprise routers managed by the central network plane. |
Parameter |
Type |
Description |
---|---|---|
enterprise_router_id |
String |
Enterprise router ID. |
project_id |
String |
Project ID. |
region_id |
String |
Region ID. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Resource ID. |
enterprise_router_id |
String |
Enterprise router ID. |
project_id |
String |
Project ID. |
region_id |
String |
Region ID. |
asn |
Long |
ASN of the network instance when BGP is used for routing. Minimum: 0 Maximum: 4294967295 |
site_code |
String |
Site code definition. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Resource ID. |
plane_id |
String |
Resource ID. |
global_connection_bandwidth_id |
String |
Global connection bandwidth ID. |
bandwidth_size |
Integer |
Bandwidth range, in Mbit/s. |
connection_type |
String |
Type of a central network connection.
|
connection_point_pair |
Array of ConnectionPoint objects |
Both ends of a central network connection. The length is fixed to an array of 2. Array Length: 2 - 2 |
state |
String |
Central network connection status.
|
Parameter |
Type |
Description |
---|---|---|
id |
String |
Resource ID. |
project_id |
String |
Project ID. |
region_id |
String |
Region ID. |
site_code |
String |
Site code definition. |
instance_id |
String |
Resource ID. |
type |
String |
Type of a central network connection point.
|
Example Requests
Querying the central network list
GET /v3/{domain_id}/gcn/central-networks
Example Responses
Status code: 200
The central network list has been queried.
{ "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 Sample Code
The SDK sample code is as follows.
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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
The central network list has been queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot