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

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

View PDF

Querying the List of Central Network Policies

Function

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

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}/policies

**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.
state	No	Array of arrays	Policy status. Multiple statuses can be queried.
version	No	Array of arrays	Version. Multiple versions can be queried.
is_applied	No	Boolean	Whether the policy is applied or not.

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_policies	Array of CentralNetworkPolicy objects	List of the central network policies.

**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** CentralNetworkPolicy
Parameter	Type	Description
id	String	Instance ID.
created_at	String	Time when the resource was created. The UTC time is in the yyyy-MM-ddTHH:mm:ss format.
domain_id	String	ID of the account that the instance belongs to.
state	String	Central network policy status. AVAILABLE: The policy is available. CANCELING: The policy is being cancelled. APPLYING: The policy is being applied. FAILED: The operation on the policy failed. DELETED: The policy is deleted.
central_network_id	String	Central network ID.
document_template_version	String	Document template version. 2022.08.30: August 30, 2022
is_applied	Boolean	Whether the policy is applied or not.
version	Integer	Version of the central network policy.
document	CentralNetworkPolicyDocument object	Central network policy document.

**Table 7** CentralNetworkPolicyDocument
Parameter	Type	Description
default_plane	String	Name of the default central network plane.
planes	Array of CentralNetworkPlaneDocument objects	List of the central network planes.
er_instances	Array of AssociateErInstanceDocument objects	List of the enterprise routers on a central network.

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

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

Example Requests

Querying the list of central network policies

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

Example Responses

Status code: 200

The list of central network policies has been queried.

{
  "request_id" : "76bfd2b0d492d0e479fbbd3981869c12",
  "page_info" : {
    "current_count" : 1
  },
  "central_network_policies" : [ {
    "id" : "f03478aa-3975-4ca7-9fb2-b49428a01636",
    "created_at" : "2023-10-09T06:22:40.857Z",
    "domain_id" : "XXX",
    "state" : "AVAILABLE",
    "central_network_id" : "e096c86f-817c-418c-945c-6b1d8860a15d",
    "document_template_version" : "2022.08.30",
    "is_applied" : true,
    "version" : 1,
    "document" : {
      "default_plane" : "default-plane",
      "planes" : [ {
        "name" : "default-plane",
        "associate_er_tables" : [ {
          "project_id" : "XXX",
          "region_id" : "region-abc",
          "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd",
          "enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e"
        } ]
      } ],
      "er_instances" : [ {
        "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd",
        "project_id" : "XXX",
        "region_id" : "region-abc"
      } ]
    }
  } ]
}