Creating an Enterprise Router
Function
This API is used to create an enterprise router. If both Default Route Table Association and Default Route Table Propagation are enabled, the system will create a route table as both the default association route table and the default propagation route table.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/enterprise-router/instances
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Client-Token |
No |
String |
Idempotence identifier Minimum: 1 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance |
Yes |
CreateEnterpriseRouter object |
Enterprise router |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Enterprise router name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). Minimum: 1 Maximum: 64 |
description |
No |
String |
Description of an enterprise router Minimum: 0 Maximum: 255 |
asn |
Yes |
Long |
Enterprise router BGP ASN |
enterprise_project_id |
No |
String |
Enterprise project ID |
charge_mode |
No |
String |
Billing mode Default: postPaid |
tags |
No |
Array of Tag objects |
Tag information |
enable_default_propagation |
No |
Boolean |
Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled. Default: false |
enable_default_association |
No |
Boolean |
Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled. Default: false |
availability_zone_ids |
Yes |
Array of strings |
AZs where the enterprise router is located Minimum: 0 Maximum: 128 |
auto_accept_shared_attachments |
No |
Boolean |
Whether to enable Auto Accept Shared Attachments. The default value is false, indicating that the function is disabled. Default: false |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Tag key. The value can contain a maximum of 36 Unicode characters, including uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). Minimum: 1 Maximum: 128 |
value |
No |
String |
Tag value.
Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
X-Client-Token |
- |
Idempotence identifier |
Parameter |
Type |
Description |
---|---|---|
instance |
EnterpriseRouter object |
Enterprise router |
request_id |
String |
Request ID |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Enterprise router ID |
name |
String |
Enterprise router name |
description |
String |
Description of an enterprise router |
state |
String |
Enterprise router status. Value options: pending, available, modifying, deleting, deleted, and failed |
tags |
Array of Tag objects |
Tag information |
charge_mode |
String |
Billing mode Default: postPaid |
created_at |
String |
Creation time in the format of YYYY-MM-DDTHH:mm:ss.sssZ |
updated_at |
String |
Update time in the format of YYYY-MM-DDTHH:MM:SS |
enterprise_project_id |
String |
Enterprise project ID |
project_id |
String |
Project ID |
asn |
Long |
Enterprise router BGP ASN |
enable_default_propagation |
Boolean |
Whether to enable the Default Route Table Propagation function. The default value is false, indicating that the function is disabled. |
enable_default_association |
Boolean |
Whether to enable the Default Route Table Association function. The default value is false, indicating that the function is disabled. |
default_propagation_route_table_id |
String |
Default propagation route table ID |
default_association_route_table_id |
String |
Default association route table ID |
availability_zone_ids |
Array of strings |
AZs where the enterprise router is located |
auto_accept_shared_attachments |
Boolean |
Whether to automatically accept shared attachments. The default value is false, indicating that the function is disabled. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. The value can contain a maximum of 36 Unicode characters, including uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). Minimum: 1 Maximum: 128 |
value |
String |
Tag value.
Minimum: 0 Maximum: 255 |
Example Requests
Creating an enterprise router
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances { "instance" : { "name" : "my_er", "description" : "this is my first enterprise router", "asn" : 64512, "enable_default_association" : true, "enable_default_propagation" : true, "tags" : [ { "key" : "key1", "value" : "value1" } ], "availability_zone_ids" : [ "az1", "az2" ] } }
Example Responses
Status code: 202
Accepted
{ "instance" : { "id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff", "name" : "my_er", "description" : "this is my first enterprise router", "asn" : 64512, "project_id" : "08d5a9564a704afda6039ae2babbef3c", "enable_default_association" : true, "enable_default_propagation" : true, "default_association_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1", "default_propagation_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1", "auto_accept_shared_attachments" : false, "created_at" : "2019-09-06 02:11:13Z", "updated_at" : "2019-09-06 02:11:13Z", "tags" : [ { "key" : "key1", "value" : "value1" } ], "enterprise_project_id" : 0, "availability_zone_ids" : [ "az1", "az2" ] }, "request_id" : "14c2b814-99dc-939a-e811-ae84c61ea3f4" }
SDK Sample Code
The SDK sample code is as follows.
Java
Creating an enterprise router
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.BasicCredentials; 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.er.v3.region.ErRegion; import com.huaweicloud.sdk.er.v3.*; import com.huaweicloud.sdk.er.v3.model.*; import java.util.List; import java.util.ArrayList; public class CreateEnterpriseRouterSolution { 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 BasicCredentials() .withAk(ak) .withSk(sk); ErClient client = ErClient.newBuilder() .withCredential(auth) .withRegion(ErRegion.valueOf("<YOUR REGION>")) .build(); CreateEnterpriseRouterRequest request = new CreateEnterpriseRouterRequest(); CreateEnterpriseRouterRequestBody body = new CreateEnterpriseRouterRequestBody(); List<String> listInstanceAvailabilityZoneIds = new ArrayList<>(); listInstanceAvailabilityZoneIds.add("az1"); listInstanceAvailabilityZoneIds.add("az2"); List<Tag> listInstanceTags = new ArrayList<>(); listInstanceTags.add( new Tag() .withKey("key1") .withValue("value1") ); CreateEnterpriseRouter instancebody = new CreateEnterpriseRouter(); instancebody.withName("my_er") .withDescription("this is my first enterprise router") .withAsn(64512L) .withTags(listInstanceTags) .withEnableDefaultPropagation(true) .withEnableDefaultAssociation(true) .withAvailabilityZoneIds(listInstanceAvailabilityZoneIds); body.withInstance(instancebody); request.withBody(body); try { CreateEnterpriseRouterResponse response = client.createEnterpriseRouter(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()); } } } |
Python
Creating an enterprise router
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 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdker.v3.region.er_region import ErRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdker.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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = ErClient.new_builder() \ .with_credentials(credentials) \ .with_region(ErRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateEnterpriseRouterRequest() listAvailabilityZoneIdsInstance = [ "az1", "az2" ] listTagsInstance = [ Tag( key="key1", value="value1" ) ] instancebody = CreateEnterpriseRouter( name="my_er", description="this is my first enterprise router", asn=64512, tags=listTagsInstance, enable_default_propagation=True, enable_default_association=True, availability_zone_ids=listAvailabilityZoneIdsInstance ) request.body = CreateEnterpriseRouterRequestBody( instance=instancebody ) response = client.create_enterprise_router(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
Creating an enterprise router
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := er.NewErClient( er.ErClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateEnterpriseRouterRequest{} var listAvailabilityZoneIdsInstance = []string{ "az1", "az2", } keyTags:= "key1" valueTags:= "value1" var listTagsInstance = []model.Tag{ { Key: &keyTags, Value: &valueTags, }, } descriptionInstance:= "this is my first enterprise router" enableDefaultPropagationInstance:= true enableDefaultAssociationInstance:= true instancebody := &model.CreateEnterpriseRouter{ Name: "my_er", Description: &descriptionInstance, Asn: int64(64512), Tags: &listTagsInstance, EnableDefaultPropagation: &enableDefaultPropagationInstance, EnableDefaultAssociation: &enableDefaultAssociationInstance, AvailabilityZoneIds: listAvailabilityZoneIdsInstance, } request.Body = &model.CreateEnterpriseRouterRequestBody{ Instance: instancebody, } response, err := client.CreateEnterpriseRouter(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
---|---|
202 |
Accepted |
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