Applying a Central Network Policy
Function
This API is used to apply a central network policy.
URI
POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies/{policy_id}/apply
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
policy_id |
Yes |
String |
Central network policy 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: 202
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
central_network_policy |
CentralNetworkPolicy object |
Details of the central network policy. |
central_network_policy_change_set |
Array of CentralNetworkElementChange objects |
List of central network policy changes. |
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.
|
central_network_id |
String |
Central network ID. |
document_template_version |
String |
Document template version.
|
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. |
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. |
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. |
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 |
---|---|---|
operation_id |
String |
Operation on a central network.
|
Example Requests
Applying a central network policy
GET /v3/{domain_id}/gcn/central-network/{central_network_id}/policies
Example Responses
Status code: 202
The central network policy has been applied.
{ "request_id" : "edb137a2c46c5bda0409833359bb649b", "central_network_policy" : { "id" : "ff51f460-4bbe-4385-b2c4-efbe3318076f", "created_at" : "2023-10-09T07:00:33.663Z", "domain_id" : "XXX", "state" : "APPLYING", "central_network_id" : "e096c86f-817c-418c-945c-6b1d8860a15d", "document_template_version" : "2022.08.30", "is_applied" : false, "version" : 2, "document" : { "default_plane" : "default-plane", "planes" : [ { "name" : "default-plane", "associate_er_tables" : [ { "project_id" : "XXX", "region_id" : "region-abc", "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", "enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0" } ] } ], "er_instances" : [ { "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", "project_id" : "XXX", "region_id" : "region-abc" } ] } }, "central_network_policy_change_set" : [ { "operation_id" : "UpdateCentralNetworkPlane", "original_central_network_plane" : { "name" : "default-plane", "is_default" : true, "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" } ] }, "newest_central_network_plane" : { "name" : "default-plane", "is_default" : true, "associate_er_tables" : [ { "project_id" : "XXX", "region_id" : "region-abc", "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", "enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0" } ] } }, { "operation_id" : "CreateCentralNetworkErInstance", "create_central_network_er_instance" : { "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", "project_id" : "XXX", "region_id" : "region-abc" } }, { "operation_id" : "DeleteCentralNetworkErInstance", "delete_central_network_er_instance" : { "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", "project_id" : "XXX", "region_id" : "region-abc" } }, { "operation_id" : "CreateCentralNetworkErConnection", "central_network_plane_name" : "default-plane", "index" : 0, "create_central_network_er_connection" : [ { "project_id" : "XXX", "region_id" : "region-abc-1", "enterprise_router_id" : "c9c9c756-6984-4866-bab7-5b55c81594bd", "enterprise_router_table_id" : "58613052-f9d4-4fa4-a3f0-6d6873190826" }, { "project_id" : "8d01a037388442f6a2e435f4f30860a3", "region_id" : "region-abc-2", "enterprise_router_id" : "58fad9c1-b4bd-4622-84e4-a0fcb2423601", "enterprise_router_table_id" : "a5347056-e29f-4192-9256-e151c61f854c" } ] }, { "operation_id" : "DeleteCentralNetworkErConnection", "central_network_plane_name" : "default-plane", "index" : 1, "delete_central_network_er_connection" : [ { "project_id" : "XXX", "region_id" : "region-abc-1", "enterprise_router_id" : "c9c9c756-6984-4866-bab7-5b55c81594bd", "enterprise_router_table_id" : "58613052-f9d4-4fa4-a3f0-6d6873190826" }, { "project_id" : "8d01a037388442f6a2e435f4f30860a3", "region_id" : "region-abc-2", "enterprise_router_id" : "58fad9c1-b4bd-4622-84e4-a0fcb2423601", "enterprise_router_table_id" : "a5347056-e29f-4192-9256-e151c61f854c" } ] }, { "operation_id" : "CreateCentralNetworkErTable", "central_network_plane_name" : "default-plane", "create_central_network_er_table" : { "project_id" : "XXX", "region_id" : "region-abc", "enterprise_router_id" : "c73b26b7-33f0-438d-b440-8e87dfe6fef9", "enterprise_router_table_id" : "c0d51f20-0313-40f7-a74e-9dccb5da21c0" } }, { "operation_id" : "DeleteCentralNetworkErTable", "central_network_plane_name" : "default-plane", "delete_central_network_er_table" : { "project_id" : "XXX", "region_id" : "region-abc", "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", "enterprise_router_table_id" : "cc542128-5c2d-402a-8960-53bb2ed9484e" } }, { "operation_id" : "SwitchCentralNetworkErTable", "central_network_plane_name" : "default-plane", "switch_central_network_er_table" : { "project_id" : "XXX", "region_id" : "region-abc", "enterprise_router_id" : "5cc75ed0-bd6c-3af4-663b-caba3315bb08", "original_enterprise_router_table_id" : "b705f49e-df88-eaf3-3aeb-95d534138156", "new_enterprise_router_table_id" : "b705f49e-df88-eaf3-3aeb-95d534138158" } } ] }
Status Codes
Status Code |
Description |
---|---|
202 |
The central network policy has been applied. |
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.