Help Center/ Cloud Connect/ API Reference/ API/ Central Networks/ Querying Central Networks by Tag

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

View PDF

Querying Central Networks by Tag

Function

This API is used to query central networks by tag.

URI

POST /v3/{domain_id}/gcn/central-networks/filter

**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. 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.

Request Parameters

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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
tags	Yes	Array of MultivaluedTag objects	Included tags.

**Table 5** MultivaluedTag
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. The key can contain a maximum of 128 Unicode characters, including letters, digits, hyphens (-), and underscores (_).
values	Yes	Array of strings	List of values with the same key.

Response Parameters

Status code: 200

**Table 6** 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 7** 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 8** 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: The central network is available. UPDATING: The central network is being updated. FAILED: The operation on the central network failed. CREATING: The central network is being created. DELETING: The central network is being deleted. DELETED: The central network is deleted. RESTORING: The central network is being restored.
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.

**Table 9** Tag
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 (.).

**Table 10** 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 11** 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 12** ExcludeErConnectionDocument
Parameter	Type	Description
[items]	Array of AssociateErInstanceDocument objects	Connections between enterprise routers managed by the central network plane.

**Table 13** AssociateErInstanceDocument
Parameter	Type	Description
enterprise_router_id	String	Enterprise router ID.
project_id	String	Project ID.
region_id	String	Region ID.

**Table 14** 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.

**Table 15** 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.
bandwidth_size	Integer	Bandwidth capacity, in Mbit/s.
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: 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.

**Table 16** 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 central networks by tag

POST https://{cc_endpoint}/v3/{domain_id}/gcn/central-networks/filter

{
  "tags" : [ {
    "key" : "key",
    "values" : [ "value" ]
  } ]
}

Example Responses

Status code: 200

Central networks have been queried by tag.

{
  "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"
  } ]
}