更新时间:2024-03-30 GMT+08:00
分享

创建企业路由器

功能介绍

创建企业路由器实例,如果使能默认关联路由表或使能默认传递路由表,那么系统会默认创建一张路由表,作为默认关联路由表或默认传递路由表。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/enterprise-router/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Client-Token

String

幂等性标识

最小长度:1

最大长度:64

表3 请求Body参数

参数

是否必选

参数类型

描述

instance

CreateEnterpriseRouter object

企业路由器

表4 CreateEnterpriseRouter

参数

是否必选

参数类型

描述

name

String

企业路由器实例名称,取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

最小长度:1

最大长度:64

description

String

企业路由器实例描述信息

最小长度:0

最大长度:255

asn

Long

企业路由器实例的BGP AS号

enterprise_project_id

String

企业项目ID

charge_mode

String

计费模式 按需

缺省值:postPaid

tags

Array of Tag objects

标签信息

enable_default_propagation

Boolean

是否开启默认路由表传播,默认false不开启

缺省值:false

enable_default_association

Boolean

是否开启默认路由表关联,默认false不开启

缺省值:false

availability_zone_ids

Array of strings

企业路由器所在的可用区列表

最小长度:0

最大长度:128

auto_accept_shared_attachments

Boolean

是否开启自动接受共享连接创建,默认false不开启

缺省值:false

表5 Tag

参数

是否必选

参数类型

描述

key

String

标签键,规则:

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及字符:下划线“_”,点“.”,冒号“:”,等号“=”,加号“+”,中划线“-”,“@”。

  • _sys_开头属于系统标签,租户不能输入。

  • 标签key不能为空(长度不能为0)。

  • 长度在1-128之间。

最小长度:1

最大长度:128

value

String

标签值,规则:

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及字符:下划线“_”,点“.”,冒号“:”,等号“=”,加号“+”,中划线“-”,“@”。

  • 资源标签值可以为空(empty or null)。

  • 长度在0-255之间。

最小长度:0

最大长度:255

响应参数

状态码: 202

表6 响应Header参数

参数

参数类型

描述

X-Client-Token

-

幂等性标识

表7 响应Body参数

参数

参数类型

描述

instance

EnterpriseRouter object

企业路由器

request_id

String

请求ID

表8 EnterpriseRouter

参数

参数类型

描述

id

String

企业路由器实例的ID

name

String

企业路由器实例名称

description

String

企业路由器实例描述信息

state

String

运行状态:pending|available|modifying|deleting|deleted|failed

tags

Array of Tag objects

标签信息

charge_mode

String

计费模式 按需

缺省值:postPaid

created_at

String

创建时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ

updated_at

String

更新时间,格式:YYYY-MM-DDTHH:mm:ss.sssZ

enterprise_project_id

String

企业项目ID

project_id

String

项目ID

asn

Long

企业路由器实例的BGP AS号

enable_default_propagation

Boolean

是否开启默认路由表传播,默认false不开启

enable_default_association

Boolean

是否开启默认路由表关联,默认false不开启

default_propagation_route_table_id

String

默认传播路由表id

default_association_route_table_id

String

默认关联路由表id

availability_zone_ids

Array of strings

企业路由器所在可用区信息

auto_accept_shared_attachments

Boolean

是否自动接受共享连接创建,默认false不开启

表9 Tag

参数

参数类型

描述

key

String

标签键,规则:

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及字符:下划线“_”,点“.”,冒号“:”,等号“=”,加号“+”,中划线“-”,“@”。

  • _sys_开头属于系统标签,租户不能输入。

  • 标签key不能为空(长度不能为0)。

  • 长度在1-128之间。

最小长度:1

最大长度:128

value

String

标签值,规则:

  • 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及字符:下划线“_”,点“.”,冒号“:”,等号“=”,加号“+”,中划线“-”,“@”。

  • 资源标签值可以为空(empty or null)。

  • 长度在0-255之间。

最小长度:0

最大长度:255

请求示例

创建一个企业路由器,名称为“my_er”,开启默认路由表关联和默认路由表传播功能

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" ]
  }
}

响应示例

状态码: 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代码示例

SDK代码示例如下。

创建一个企业路由器,名称为“my_er”,开启默认路由表关联和默认路由表传播功能

 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());
        }
    }
}

创建一个企业路由器,名称为“my_er”,开启默认路由表关联和默认路由表传播功能

 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)

创建一个企业路由器,名称为“my_er”,开启默认路由表关联和默认路由表传播功能

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

202

Accepted

错误码

请参见错误码

相关文档