Creating a Static Route
Function
This API is used to create a static route. Static routes are manually created, and valid routes are preferred routes.
Constraints
If is_blackhole is set to false, the attachment_id parameter must be passed. If is_blackhole is set to true, the attachment_id parameter cannot be passed.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
route_table_id |
Yes |
String |
Route table ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Client-Token |
No |
String |
Idempotence identifier Minimum: 1 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
route |
Yes |
CreateRoute object |
Request body for creating a route |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
destination |
Yes |
String |
Destination address of a route Minimum: 0 Maximum: 256 |
attachment_id |
No |
String |
ID of the attachment that the next hop of the route points to |
is_blackhole |
No |
Boolean |
Whether the route is a blackhole route. The default value is false. |
description |
No |
String |
Route description Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
X-Client-Token |
String |
Idempotence identifier |
Parameter |
Type |
Description |
---|---|---|
route |
Route object |
Route |
request_id |
String |
Request ID |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Route ID |
type |
String |
Route type. The value is static. |
state |
String |
Route status. Value options: pending, available, modifying, deleting, deleted, and failed |
is_blackhole |
Boolean |
Whether the route is a blackhole route |
destination |
String |
Destination address of a route |
attachments |
Array of RouteAttachment objects |
Next hops |
route_table_id |
String |
Route table ID |
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.sssZ |
description |
String |
Route description |
Parameter |
Type |
Description |
---|---|---|
resource_id |
String |
Attached resource ID |
resource_type |
String |
Attachment type.
|
attachment_id |
String |
Attachment ID |
Example Requests
Creating a static route (not a blackhole route) destined for 192.168.0.0/16 through the specified attachment
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/0d1748a0-5188-11e5-b86f-a51b5f125b84/static-routes
{
"route" : {
"destination" : "192.168.0.0/16",
"is_blackhole" : false,
"attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
}
}
Example Responses
Status code: 202
Accepted
{
"route" : {
"id" : "9b3b38a9-1c9d-4f01-9429-81af6b545289",
"type" : "static",
"destination" : "192.168.0.0/16",
"description" : "static route",
"attachments" : [ {
"resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
"resource_type" : "vpc",
"attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
} ],
"route_table_id" : "0d1748a0-5188-11e5-b86f-a51b5f125b84",
"is_blackhole" : false,
"state" : "pending",
"created_at" : "2020-03-11T15:13:31Z",
"updated_at" : "2020-03-11T15:13:31Z"
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}
SDK Sample Code
The SDK sample code is as follows.
Java
Creating a static route (not a blackhole route) destined for 192.168.0.0/16 through the specified attachment
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 |
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.*;
public class CreateStaticRouteSolution {
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");
String projectId = "{project_id}";
ICredential auth = new BasicCredentials()
.withProjectId(projectId)
.withAk(ak)
.withSk(sk);
ErClient client = ErClient.newBuilder()
.withCredential(auth)
.withRegion(ErRegion.valueOf("<YOUR REGION>"))
.build();
CreateStaticRouteRequest request = new CreateStaticRouteRequest();
request.withRouteTableId("{route_table_id}");
CreateRouteRequestBody body = new CreateRouteRequestBody();
CreateRoute routebody = new CreateRoute();
routebody.withDestination("192.168.0.0/16")
.withAttachmentId("b70aee08-c671-4cad-9fd5-7381d163bcc8")
.withIsBlackhole(false);
body.withRoute(routebody);
request.withBody(body);
try {
CreateStaticRouteResponse response = client.createStaticRoute(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 a static route (not a blackhole route) destined for 192.168.0.0/16 through the specified attachment
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 |
# coding: utf-8
import os
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 = os.environ["CLOUD_SDK_AK"]
sk = os.environ["CLOUD_SDK_SK"]
projectId = "{project_id}"
credentials = BasicCredentials(ak, sk, projectId)
client = ErClient.new_builder() \
.with_credentials(credentials) \
.with_region(ErRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateStaticRouteRequest()
request.route_table_id = "{route_table_id}"
routebody = CreateRoute(
destination="192.168.0.0/16",
attachment_id="b70aee08-c671-4cad-9fd5-7381d163bcc8",
is_blackhole=False
)
request.body = CreateRouteRequestBody(
route=routebody
)
response = client.create_static_route(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 a static route (not a blackhole route) destined for 192.168.0.0/16 through the specified attachment
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 |
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")
projectId := "{project_id}"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
WithProjectId(projectId).
Build()
client := er.NewErClient(
er.ErClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateStaticRouteRequest{}
request.RouteTableId = "{route_table_id}"
attachmentIdRoute:= "b70aee08-c671-4cad-9fd5-7381d163bcc8"
isBlackholeRoute:= false
routebody := &model.CreateRoute{
Destination: "192.168.0.0/16",
AttachmentId: &attachmentIdRoute,
IsBlackhole: &isBlackholeRoute,
}
request.Body = &model.CreateRouteRequestBody{
Route: routebody,
}
response, err := client.CreateStaticRoute(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