Updated on 2025-03-20 GMT+08:00

Updating an Enterprise Router

Function

This API is used to update basic information about the enterprise router.

Constraints

Information (except name and description) can be updated only when the enterprise router is in the available state.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{project_id}/enterprise-router/instances/{er_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

er_id

Yes

String

Enterprise router ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

instance

No

UpdateEnterpriseRouter object

Request body for updating an enterprise router

Table 3 UpdateEnterpriseRouter

Parameter

Mandatory

Type

Description

name

No

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

enable_default_propagation

No

Boolean

Whether to enable Default Route Table Propagation.

enable_default_association

No

Boolean

Whether to enable Default Route Table Association.

default_propagation_route_table_id

No

String

Default propagation route table ID

default_association_route_table_id

No

String

Default association route table ID

auto_accept_shared_attachments

No

Boolean

Whether to enable Auto Accept Shared Attachments. The default value is false, indicating that this option is disabled.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

instance

EnterpriseRouter object

Enterprise router

request_id

String

Request ID

Table 5 EnterpriseRouter

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 (pay-per-use)

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.sssZ

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 Default Route Table Propagation. The default value is false, indicating that this option is disabled.

enable_default_association

Boolean

Whether to enable Default Route Table Association. The default value is false, indicating that this option 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 enable Auto Accept Shared Attachments. The default value is false, indicating that this option is disabled.

Table 6 Tag

Parameter

Type

Description

key

String

Tag key.

  • A tag key can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag key cannot be left blank.

  • A tag key can contain 1 to 128 characters.

  • Tags with the tag key starting with _sys_ are system tags and cannot be added by tenants.

Minimum: 1

Maximum: 128

value

String

Tag value.

  • A tag value can contain letters, digits, spaces encoded using UTF-8, and special characters _.:=+-@

  • A tag value can be left blank or set to null.

  • A tag value can contain 0 to 255 characters.

Minimum: 0

Maximum: 255

Example Requests

Updating an enterprise router to enable Default Route Table Association and Default Route Table Propagation and specify route table

PUT https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances/94c2b814-99dc-939a-e811-ae84c61ea3ff

{
  "instance" : {
    "enable_default_association" : true,
    "enable_default_propagation" : true,
    "default_propagation_route_table_id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
    "default_association_route_table_id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff"
  }
}

Example Responses

Status code: 200

OK

{
  "instance" : {
    "id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
    "name" : "my_er",
    "description" : "this is my first enterprise router",
    "project_id" : "08d5a9564a704afda6039ae2babbef3c",
    "state" : "pending",
    "asn" : 64512,
    "enable_default_association" : true,
    "enable_default_propagation" : true,
    "default_propagation_route_table_id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
    "default_association_route_table_id" : "94c2b814-99dc-939a-e811-ae84c61ea3ff",
    "auto_accept_shared_attachments" : false,
    "availability_zone_ids" : [ "az1" ],
    "created_at" : "2019-09-06 02:11:13Z",
    "updated_at" : "2019-09-06 02:11:13Z"
  },
  "request_id" : "14c2b814-99dc-939b-e81c-ae84c61ea3f7"
}

SDK Sample Code

The SDK sample code is as follows.

Java

Updating an enterprise router to enable Default Route Table Association and Default Route Table Propagation and specify route table

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

    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();
        UpdateEnterpriseRouterRequest request = new UpdateEnterpriseRouterRequest();
        request.withErId("{er_id}");
        UpdateEnterpriseRouterRequestBody body = new UpdateEnterpriseRouterRequestBody();
        UpdateEnterpriseRouter instancebody = new UpdateEnterpriseRouter();
        instancebody.withEnableDefaultPropagation(true)
            .withEnableDefaultAssociation(true)
            .withDefaultPropagationRouteTableId("94c2b814-99dc-939a-e811-ae84c61ea3ff")
            .withDefaultAssociationRouteTableId("94c2b814-99dc-939a-e811-ae84c61ea3ff");
        body.withInstance(instancebody);
        request.withBody(body);
        try {
            UpdateEnterpriseRouterResponse response = client.updateEnterpriseRouter(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

Updating an enterprise router to enable Default Route Table Association and Default Route Table Propagation and specify route table

 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
# 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 = UpdateEnterpriseRouterRequest()
        request.er_id = "{er_id}"
        instancebody = UpdateEnterpriseRouter(
            enable_default_propagation=True,
            enable_default_association=True,
            default_propagation_route_table_id="94c2b814-99dc-939a-e811-ae84c61ea3ff",
            default_association_route_table_id="94c2b814-99dc-939a-e811-ae84c61ea3ff"
        )
        request.body = UpdateEnterpriseRouterRequestBody(
            instance=instancebody
        )
        response = client.update_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

Updating an enterprise router to enable Default Route Table Association and Default Route Table Propagation and specify route table

 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 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.UpdateEnterpriseRouterRequest{}
	request.ErId = "{er_id}"
	enableDefaultPropagationInstance:= true
	enableDefaultAssociationInstance:= true
	defaultPropagationRouteTableIdInstance:= "94c2b814-99dc-939a-e811-ae84c61ea3ff"
	defaultAssociationRouteTableIdInstance:= "94c2b814-99dc-939a-e811-ae84c61ea3ff"
	instancebody := &model.UpdateEnterpriseRouter{
		EnableDefaultPropagation: &enableDefaultPropagationInstance,
		EnableDefaultAssociation: &enableDefaultAssociationInstance,
		DefaultPropagationRouteTableId: &defaultPropagationRouteTableIdInstance,
		DefaultAssociationRouteTableId: &defaultAssociationRouteTableIdInstance,
	}
	request.Body = &model.UpdateEnterpriseRouterRequestBody{
		Instance: instancebody,
	}
	response, err := client.UpdateEnterpriseRouter(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

200

OK

Error Codes

See Error Codes.