Help Center/ Cloud Connect/ API Reference/ API/ Central Network Connections/ Querying the List of Central Network Connections

Updated on 2025-07-29 GMT+08:00

View PDF

Querying the List of Central Network Connections

Function

This API is used to query the list of central network connections.

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.

URI

GET /v3/{domain_id}/gcn/central-network/{central_network_id}/connections

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID.
central_network_id	Yes	String	Central network ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records returned on each page. Value range: 1-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.
sort_key	No	String	Field for sorting.
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 of arrays	Resource ID. Multiple IDs can be queried.
name	No	Array of strings	Resource name. Multiple names can be queried.
state	No	Array of arrays	Central network connection status. Multiple statuses can be queried.
global_connection_bandwidth_id	No	Array of arrays	Bandwidth package IDs.
bandwidth_type	No	Object	Bandwidth type. The bandwidth types are as follows: BandwidthPackage: A global connection bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global connection bandwidth. TestBandwidth: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity.
connection_type	No	Object	Connection type.
is_cross_region	No	Boolean	Whether there are different regions.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Request ID.
page_info	PageInfo object	Pagination query information.
central_network_connections	Array of CentralNetworkConnection objects	List of the central network connections.

**Table 5** PageInfo
Parameter	Type	Description
next_marker	String	Backward pagination identifier.
previous_marker	String	Forward pagination identifier.
current_count	Integer	Number of the resources in the current list.

**Table 6** CentralNetworkConnection
Parameter	Type	Description
id	String	Instance ID.
name	String	Instance name.
description	String	Resource description. Angle brackets (<>) are not allowed.
domain_id	String	ID of the account that the instance belongs to.
enterprise_project_id	String	ID of the enterprise project that the resource belongs to.
central_network_id	String	Central network ID.
central_network_plane_id	String	ID of the central network plane.
global_connection_bandwidth_id	String	Global connection bandwidth ID.
bandwidth_type	String	Bandwidth type. The bandwidth types are as follows: BandwidthPackage: A global connection bandwidth billed by fixed bandwidth is required, and cross-site connection bandwidths are assigned from the global connection bandwidth. TestBandwidth: The test bandwidth is free. Only the minimum bandwidth is used for testing cross-region connectivity.
bandwidth_size	Integer	Bandwidth capacity, in Mbit/s.
state	String	Central network connection status. AVAILABLE: The connection is available. CREATING: The connection is being created. UPDATING: The connection is being updated. DELETING: The connection is being deleted. FREEZING: The connection is being frozen. UNFREEZING: The connection is being unfrozen. RECOVERING: The connection is being recovered. FAILED: The operation on the connection failed. DELETED: The connection is deleted. APPROVING: The connection is being approved. APPROVED: The connection is approved. UNAPPROVED: The approval failed.
is_frozen	Boolean	Whether the resource is frozen.
connection_type	String	Type of a central network connection. ER-ER: peering connection between enterprise routers ER-GDGW: connection between an enterprise router and a global DC gateway ER-ER_ROUTE_TABLE: connection between an enterprise router and an enterprise router route table
connection_point_pair	Array of ConnectionPoint objects	Both ends of a central network connection. The length is fixed to an array of 2.
created_at	String	Time when the resource was created. The UTC time is in the yyyy-MM-ddTHH:mm:ss format.
updated_at	String	Time when the resource was updated. The UTC time must be in the yyyy-MM-ddTHH:mm:ss format.

**Table 7** ConnectionPoint
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 the resource that can be added to a central network as an attachment. ER: enterprise router GDGW: global DC gateway ER_ROUTE_TABLE: enterprise router route table

Example Requests

Querying the list of central network connections

GET /v3/{domain_id}/gcn/central-network/{central_network_id}/connections

Example Responses

Status code: 200

The list of central network connections has been queried.

{
  "request_id" : "0050ea65af7e190d9a791d9e69f28e63",
  "page_info" : {
    "current_count" : 1
  },
  "central_network_connections" : [ {
    "id" : "eb350a5c-06c1-4b12-9ae4-3820f31faaa0",
    "name" : "er-connection",
    "domain_id" : "XXX",
    "enterprise_project_id" : "0",
    "central_network_id" : "43ad756e-2780-463e-a8ed-27a5bd77b7a7",
    "central_network_plane_id" : "238f60d5-ed1a-4508-8473-45509c530c8f",
    "bandwidth_type" : "TestBandwidth",
    "state" : "AVAILABLE",
    "is_frozen" : false,
    "connection_type" : "ER-ER",
    "connection_point_pair" : [ {
      "id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a",
      "project_id" : "XXX",
      "region_id" : "region-abc",
      "site_code" : "region-abc",
      "instance_id" : "d238dd85-f769-485b-aa05-d20e1d3889df",
      "type" : "ER"
    }, {
      "id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b1",
      "project_id" : "XXX",
      "region_id" : "region-abc",
      "site_code" : "region-abc",
      "instance_id" : "96abbb18-4a77-4103-aa8e-b1c836154282",
      "type" : "ER"
    } ],
    "created_at" : "2023-10-09T08:02:43.31Z",
    "updated_at" : "2023-10-09T08:02:43.307Z"
  } ]
}