doc-exports/docs/ccn/api-ref/ListCentralNetworks.html

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.

URI

GET /v3/{domain_id}/gcn/central-networks

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID.

Table 2 Query Parameters

Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records returned on each page. The value ranges from 1 to 2000.
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 strings	Resource ID. Multiple IDs can be queried.
name	No	Array of strings	The resource name used for query. Multiple names can be specified for query.
state	No	Array of strings	Resource status. Multiple statuses can be used for query. AVAILABLE UPDATING FAILED CREATING DELETING DELETED RESTORING
enterprise_project_id	No	Array of strings	Enterprise project IDs.
enterprise_router_id	No	Array of strings	Enterprise router IDs.
attachment_instance_id	No	Array of strings	Attachment ID.
global_connection_bandwidth_id	No	Array of strings	Bandwidth package IDs.
connection_id	No	Array of strings	Connection ID.

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_networks	Array of CentralNetwork objects	Central network list.

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 CentralNetwork

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 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.
domain_id	String	ID of the account that the instance belongs to.
state	String	Central network status. AVAILABLE UPDATING FAILED CREATING DELETING DELETED RESTORING
enterprise_project_id	String	ID of the enterprise project that the resource belongs to.
default_plane_id	String	ID of the default central network plane.
auto_associate_route_enabled	Boolean	Whether to enable Default Route Table Association. This parameter has been discarded. Please do not use it.
auto_propagate_route_enabled	Boolean	Whether to enable Default Route Table Propagation. This parameter has been discarded. Please do not use it.
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.

Table 7 CentralNetworkPlane

Parameter	Type	Description
id	String	Instance ID.
name	String	Instance name.
associate_er_tables	Array of AssociateErTableDocument objects	List of the enterprise routers on a central network.
exclude_er_connections	Array of ExcludeErConnectionDocument objects	Whether to exclude the connections to enterprise routers on the central network.

Table 8 AssociateErTableDocument

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.

Table 9 ExcludeErConnectionDocument

Parameter	Type	Description
[items]	Array of AssociateErInstanceDocument objects	Connections between enterprise routers managed by the central network plane.

Table 10 AssociateErInstanceDocument

Parameter	Type	Description
enterprise_router_id	String	Enterprise router ID.
project_id	String	Project ID.
region_id	String	Region ID.

Table 11 CentralNetworkErInstance

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. You can obtain the code by calling the API for querying the site list of the global connection bandwidth.

Table 12 CentralNetworkConnectionInfo

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. If bandwidth_type is set to TestBandwidth, no global connection bandwidth is bound, and this parameter is not displayed.
bandwidth_size	Long	Bandwidth range, in Mbit/s. If bandwidth_type is set to TestBandwidth, the bandwidth size is the default value, and this parameter is not displayed.
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.
state	String	Central network connection status. AVAILABLE CREATING UPDATING DELETING FREEZING UNFREEZING RECOVERING FAILED DELETED APPROVING APPROVED UNAPPROVED

Table 13 ConnectionPoint

Parameter	Type	Description
id	String	Instance ID.
project_id	String	Project ID.
region_id	String	Region ID.
site_code	String	Site code. You can obtain the code by calling the API for querying the site list of the global connection bandwidth.
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 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"
  } ]
}

Status Codes

Status Code	Description
200	The central network list has been queried.

Error Codes

See Error Codes.

Parent topic: Central Networks