文档首页/ 企业路由器 ER/ API参考/ API/ 企业路由器/ 更新企业路由器
更新时间：2024-04-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新企业路由器

功能介绍

更新企业路由器基本信息。

接口约束

除了name和description，其它信息只有在企业路由器实例状态为available的时候才能更新。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

er_id

是

String

企业路由器实例ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instance

否

UpdateEnterpriseRouter object

更新企业路由器请求体
表3 UpdateEnterpriseRouter

参数

是否必选

参数类型

描述

name

否

String

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

最小长度：1

最大长度：64

description

否

String

企业路由器实例描述信息

最小长度：0

最大长度：255

enable_default_propagation

否

Boolean

是否开启默认传播

enable_default_association

否

Boolean

是否开启默认关联

default_propagation_route_table_id

否

String

默认传播路由表ID

default_association_route_table_id

否

String

默认关联路由表ID

auto_accept_shared_attachments

否

Boolean

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

instance

EnterpriseRouter object

企业路由器

request_id

String

请求ID
表5 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不开启
表6 Tag

参数

参数类型

描述

key

String

标签键，规则：

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

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

  • 标签key不能为空（长度不能为0）。

  • 长度在1-128之间。

最小长度：1

最大长度：128

value

String

标签值，规则：

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

  • 资源标签值可以为空（empty or null）。

  • 长度在0-255之间。

最小长度：0

最大长度：255

请求示例

更新企业路由器，开启默认路由表关联和默认路由表传播功能，并指定对应的路由表

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

响应示例

状态码： 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"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 企业路由器