Help Center/ Enterprise Router/ API Reference/ APIs/ Routes/ Updating a Static Route
Updated on 2024-04-19 GMT+08:00

Updating a Static Route

Function

This API is used to update a static route.

Constraints

If is_blackhole is set to false, the attachment_id parameter must be carried. If is_blackhole is set to true, the attachment_id parameter cannot be passed.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/enterprise-router/route-tables/{route_table_id}/static-routes/{route_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

route_table_id

Yes

String

Route table ID

route_id

Yes

String

Route ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

route

Yes

UpdateRoute object

Route

Table 3 UpdateRoute

Parameter

Mandatory

Type

Description

attachment_id

No

String

Next hop of the route

is_blackhole

No

Boolean

Whether the route is a blackhole route

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

route

Route object

Route

request_id

String

Request ID

Table 5 Route

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 the 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

Table 6 RouteAttachment

Parameter

Type

Description

resource_id

String

Attached resource ID

resource_type

String

Attachment type.

  • vpc: VPC attachment

  • vpn: VPN gateway attachment

  • vgw: virtual gateway attachment

  • peering: peering connection attachment. A cloud connection is used to connect two enterprise routers from different regions.

  • cfw: CFW instance attachment

  • ecn: ECN attachment

attachment_id

String

Attachment ID

Example Requests

Modifying a static route

PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/route-tables/19d334b7-78c1-4e0e-ba29-b797e641e23c/static-routes/9b3b38a9-1c9d-4f01-9429-81af6b545289

{
  "route" : {
    "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",
    "attachments" : [ {
      "resource_id" : "9c4ab06a-0ab4-4fad-93a8-f733f3a4433d",
      "resource_type" : "vpc",
      "attachment_id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8"
    } ],
    "route_table_id" : "19d334b7-78c1-4e0e-ba29-b797e641e23c",
    "is_blackhole" : false,
    "state" : "pending",
    "created_at" : "2020-03-11T15:13:31",
    "updated_at" : "2020-03-11T15:13:31"
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}

SDK Sample Code

The SDK sample code is as follows.

Java

Modifying a static route

 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
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 UpdateStaticRouteSolution {

    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();
        UpdateStaticRouteRequest request = new UpdateStaticRouteRequest();
        UpdateRouteRequestBody body = new UpdateRouteRequestBody();
        UpdateRoute routebody = new UpdateRoute();
        routebody.withAttachmentId("b70aee08-c671-4cad-9fd5-7381d163bcc8")
            .withIsBlackhole(false);
        body.withRoute(routebody);
        request.withBody(body);
        try {
            UpdateStaticRouteResponse response = client.updateStaticRoute(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

Modifying a static route

 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
# 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 = UpdateStaticRouteRequest()
        routebody = UpdateRoute(
            attachment_id="b70aee08-c671-4cad-9fd5-7381d163bcc8",
            is_blackhole=False
        )
        request.body = UpdateRouteRequestBody(
            route=routebody
        )
        response = client.update_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

Modifying a static route

 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
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.UpdateStaticRouteRequest{}
	attachmentIdRoute:= "b70aee08-c671-4cad-9fd5-7381d163bcc8"
	isBlackholeRoute:= false
	routebody := &model.UpdateRoute{
		AttachmentId: &attachmentIdRoute,
		IsBlackhole: &isBlackholeRoute,
	}
	request.Body = &model.UpdateRouteRequestBody{
		Route: routebody,
	}
	response, err := client.UpdateStaticRoute(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.