Help Center/ Enterprise Router/ API Reference/ APIs/ Enterprise Routers/ Changing Enterprise Router AZs
Updated on 2024-04-19 GMT+08:00

Changing Enterprise Router AZs

Function

This API is used to change enterprise router AZs. The AZs can be changed only when the enterprise router is in the available state.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/enterprise-router/instances/{er_id}/change-availability-zone-ids

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

availability_zone_ids

Yes

Array of strings

AZs where the enterprise router is located

Minimum: 1

Maximum: 256

Response Parameters

Status code: 202

Table 3 Response body parameters

Parameter

Type

Description

instance

EnterpriseRouter object

Enterprise router

request_id

String

Request ID

Table 4 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

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.

Table 5 Tag

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.

  • Tag values consist of letters, digits, spaces, and special characters _.:=+-@

  • Tag values can contain 0 to 255 characters.

  • Tag values can be left blank or set to null.

Minimum: 0

Maximum: 255

Example Requests

Changing Enterprise Router Azs

POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/instances/cccf35ad-fd0d-4043-aab2-dc28ae56f967/change-availability-zone-ids

{
  "availability_zone_ids" : [ "az1" ]
}

Example Responses

Status code: 202

Accepted

{
  "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_association_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
    "default_propagation_route_table_id" : "7f7f738f-453c-40b1-be26-28e7b9e390c1",
    "availability_zone_ids" : [ "az1" ],
    "created_at" : "2019-09-06 02:11:13Z",
    "updated_at" : "2019-09-06 02:11:13Z"
  },
  "request_id" : "5f7f738f-453c-40b1-be26-28e7b9e390c2"
}

SDK Sample Code

The SDK sample code is as follows.

Java

Changing Enterprise Router Azs

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

    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();
        ChangeAvailabilityZoneRequest request = new ChangeAvailabilityZoneRequest();
        EnterpriseRouterAZ body = new EnterpriseRouterAZ();
        List<String> listbodyAvailabilityZoneIds = new ArrayList<>();
        listbodyAvailabilityZoneIds.add("az1");
        body.withAvailabilityZoneIds(listbodyAvailabilityZoneIds);
        request.withBody(body);
        try {
            ChangeAvailabilityZoneResponse response = client.changeAvailabilityZone(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

Changing Enterprise Router Azs

 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
# 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 = ChangeAvailabilityZoneRequest()
        listAvailabilityZoneIdsbody = [
            "az1"
        ]
        request.body = EnterpriseRouterAZ(
            availability_zone_ids=listAvailabilityZoneIdsbody
        )
        response = client.change_availability_zone(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

Changing Enterprise Router Azs

 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
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.ChangeAvailabilityZoneRequest{}
	var listAvailabilityZoneIdsbody = []string{
        "az1",
    }
	request.Body = &model.EnterpriseRouterAz{
		AvailabilityZoneIds: listAvailabilityZoneIdsbody,
	}
	response, err := client.ChangeAvailabilityZone(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.