Adding a Central Network Policy
Function
This API is used to add a central network policy. A policy cannot be modified. If the policy cannot meet your requirements, you need to add a new policy.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
central_network_id |
Yes |
String |
Central network ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
central_network_policy_document |
Yes |
CentralNetworkPolicyDocument object |
Central network policy document. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
default_plane |
Yes |
String |
Name of the default central network plane. |
planes |
Yes |
Array of CentralNetworkPlaneDocument objects |
List of the central network planes. |
er_instances |
No |
Array of AssociateErInstanceDocument objects |
List of the enterprise routers on the central network. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Instance name. |
associate_er_tables |
No |
Array of AssociateErTableDocument objects |
List of the enterprise routers on the central network. |
exclude_er_connections |
No |
Array of ExcludeErConnectionDocument objects |
Whether to exclude the connections to enterprise routers on the central network. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
region_id |
Yes |
String |
Region ID. |
enterprise_router_id |
Yes |
String |
Enterprise router ID. |
enterprise_router_table_id |
Yes |
String |
ID of the enterprise router route table. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
[items] |
No |
Array of AssociateErInstanceDocument objects |
Connections between enterprise routers managed by the central network plane. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
central_network_policy |
CentralNetworkPolicy object |
Details of the central network policy. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Instance ID. |
created_at |
String |
Time when the resource was created. The 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 the central network. |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Instance name. |
associate_er_tables |
Array of AssociateErTableDocument objects |
List of the enterprise routers on the 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. |
Example Requests
Adding a central network policy
POST /v3/{domain_id}/gcn/central-network/{central_network_id}/policies { "central_network_policy_document" : { "default_plane" : "default-plane", "planes" : [ { "name" : "default-plane" } ], "er_instances" : [ { "enterprise_router_id" : "395b0884-aab4-4bf0-8cb8-7f2da26708dd", "project_id" : "XXX", "region_id" : "region-abc" } ] } }
Example Responses
Status code: 201
The central network policy has been added.
{ "request_id" : "76bfd2b0d492d0e479fbbd3981869c12", "central_network_policy" : { "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" } ] } } }
SDK Sample Code
The SDK sample code is as follows.
Adding a central network policy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cc.v3.region.CcRegion; import com.huaweicloud.sdk.cc.v3.*; import com.huaweicloud.sdk.cc.v3.model.*; import java.util.List; import java.util.ArrayList; public class CreateCentralNetworkPolicySolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CcClient client = CcClient.newBuilder() .withCredential(auth) .withRegion(CcRegion.valueOf("<YOUR REGION>")) .build(); CreateCentralNetworkPolicyRequest request = new CreateCentralNetworkPolicyRequest(); request.withCentralNetworkId("{central_network_id}"); CreateCentralNetworkPolicyRequestBody body = new CreateCentralNetworkPolicyRequestBody(); List<AssociateErInstanceDocument> listCentralNetworkPolicyDocumentErInstances = new ArrayList<>(); listCentralNetworkPolicyDocumentErInstances.add( new AssociateErInstanceDocument() .withEnterpriseRouterId("395b0884-aab4-4bf0-8cb8-7f2da26708dd") .withRegionId("region-abc") .withProjectId("XXX") ); List<CentralNetworkPlaneDocument> listCentralNetworkPolicyDocumentPlanes = new ArrayList<>(); listCentralNetworkPolicyDocumentPlanes.add( new CentralNetworkPlaneDocument() .withName("default-plane") ); CentralNetworkPolicyDocument centralNetworkPolicyDocumentbody = new CentralNetworkPolicyDocument(); centralNetworkPolicyDocumentbody.withDefaultPlane("default-plane") .withPlanes(listCentralNetworkPolicyDocumentPlanes) .withErInstances(listCentralNetworkPolicyDocumentErInstances); body.withCentralNetworkPolicyDocument(centralNetworkPolicyDocumentbody); request.withBody(body); try { CreateCentralNetworkPolicyResponse response = client.createCentralNetworkPolicy(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Adding a central network policy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcc.v3.region.cc_region import CcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcc.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = CcClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateCentralNetworkPolicyRequest() request.central_network_id = "{central_network_id}" listErInstancesCentralNetworkPolicyDocument = [ AssociateErInstanceDocument( enterprise_router_id="395b0884-aab4-4bf0-8cb8-7f2da26708dd", region_id="region-abc", project_id="XXX" ) ] listPlanesCentralNetworkPolicyDocument = [ CentralNetworkPlaneDocument( name="default-plane" ) ] centralNetworkPolicyDocumentbody = CentralNetworkPolicyDocument( default_plane="default-plane", planes=listPlanesCentralNetworkPolicyDocument, er_instances=listErInstancesCentralNetworkPolicyDocument ) request.body = CreateCentralNetworkPolicyRequestBody( central_network_policy_document=centralNetworkPolicyDocumentbody ) response = client.create_central_network_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Adding a central network policy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cc.NewCcClient( cc.CcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateCentralNetworkPolicyRequest{} request.CentralNetworkId = "{central_network_id}" var listErInstancesCentralNetworkPolicyDocument = []model.AssociateErInstanceDocument{ { EnterpriseRouterId: "395b0884-aab4-4bf0-8cb8-7f2da26708dd", RegionId: "region-abc", ProjectId: "XXX", }, } var listPlanesCentralNetworkPolicyDocument = []model.CentralNetworkPlaneDocument{ { Name: "default-plane", }, } centralNetworkPolicyDocumentbody := &model.CentralNetworkPolicyDocument{ DefaultPlane: "default-plane", Planes: listPlanesCentralNetworkPolicyDocument, ErInstances: &listErInstancesCentralNetworkPolicyDocument, } request.Body = &model.CreateCentralNetworkPolicyRequestBody{ CentralNetworkPolicyDocument: centralNetworkPolicyDocumentbody, } response, err := client.CreateCentralNetworkPolicy(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
201 |
The central network policy has been added. |
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot