Querying a Central Network
Function
This API is used to query the details of a central network.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v3/{domain_id}/gcn/central-networks/{central_network_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
central_network_id |
Yes |
String |
Central network ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
central_network |
CentralNetwork object |
Central network. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
name |
String |
Instance name. |
description |
String |
Resource description. Angle brackets (<>) are not allowed. |
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 resource belongs to. |
tags |
Array of Tag objects |
Resource tags. |
default_plane_id |
String |
ID of the default central network plane. |
planes |
Array of CentralNetworkPlane objects |
List of central network planes. |
er_instances |
Array of CentralNetworkErInstance objects |
List of enterprise routers on a central network. |
connections |
Array of CentralNetworkConnectionInfo objects |
List of the enterprise router attachments on a central network. |
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 |
Instance ID. |
name |
String |
Instance name. |
associate_er_tables |
Array of AssociateErTableDocument objects |
List of the enterprise routers on the central network. |
exclude_er_connections |
Array of ExcludeErConnectionDocument objects |
Whether to exclude the connections to enterprise routers on the central network. |
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 |
ID of the enterprise router route table. |
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 |
Instance 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. |
site_code |
String |
Site code. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
plane_id |
String |
ID of the central network plane. |
global_connection_bandwidth_id |
String |
Global connection bandwidth ID. |
bandwidth_size |
Integer |
Amount of bandwidth, 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. |
state |
String |
Central network connection status.
|
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
project_id |
String |
Project ID. |
region_id |
String |
Region ID. |
site_code |
String |
Site code. |
instance_id |
String |
Instance ID at an end of a connection. |
parent_instance_id |
String |
Parent resource ID of the instance at an end of a connection. |
type |
String |
Type of a central network connection point.
|
Example Requests
Query the details of a central network
GET /v3/{domain_id}/gcn/central-networks/{central_network_id}
Example Responses
Status code: 200
The details of a central network have been queried.
{ "request_id" : "ebfebe2205832c9ed7c3d1131041cc0f", "central_network" : { "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 |
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 ShowCentralNetworkSolution { 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(); ShowCentralNetworkRequest request = new ShowCentralNetworkRequest(); request.withCentralNetworkId("{central_network_id}"); try { ShowCentralNetworkResponse response = client.showCentralNetwork(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 = ShowCentralNetworkRequest() request.central_network_id = "{central_network_id}" response = client.show_central_network(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.ShowCentralNetworkRequest{} request.CentralNetworkId = "{central_network_id}" response, err := client.ShowCentralNetwork(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 details of a central network have 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