文档首页/ 企业交换机 ESW/ API参考/ 企业交换机/ 更新ESW实例 - UpdateInstance
更新时间：2025-11-20 GMT+08:00
查看PDF
分享

更新ESW实例 - UpdateInstance

功能介绍

当您的ESW实例创建成功后，您可以通过调用此接口更新一个ESW实例的名称或者描述信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

esw:instance:update

Write

-

-

-

-

URI

PUT /v3/{project_id}/l2cg/instances/{instance_id}

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

  • 参数解释：ESW实例的唯一标识。

  • 约束限制：带“-”的UUID格式。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

project_id

是

String

  • 参数解释：ESW实例所属项目ID。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

instance

是

UpdateInstanceOption object

  • 参数解释：更新实例信息的请求体。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表3 UpdateInstanceOption

参数

是否必选

参数类型

描述

description

否

String

  • 参数解释：ESW实例描述信息。

  • 约束限制：

    • 长度范围为0~255个字符。

    • 不能包含“<”和“>”。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

name

否

String

  • 参数解释：ESW实例名称。

  • 约束限制：

    • 长度范围为1~64个字符。

    • 名称由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

request_id

String

  • 参数解释：请求的唯一标识。

  • 约束限制：UUID格式。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

instance

Instance object

  • 参数解释：更新实例信息的响应体。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表5 Instance

参数

参数类型

描述

id

String

  • 参数解释：ESW实例的唯一标识。

  • 约束限制：带“-”的UUID格式。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

name

String

  • 参数解释：ESW实例名称。

  • 约束限制：

    • 长度范围为1~64个字符。

    • 名称由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

project_id

String

  • 参数解释：ESW实例所属项目ID。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

region

String

  • 参数解释：ESW实例所属region的ID。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

flavor_ref

String

  • 参数解释：ESW实例规格。

  • 约束限制：不涉及。

  • 取值范围：参考flavor list接口响应。

  • 默认取值：不涉及。

ha_mode

String

  • 参数解释：ESW实例的高可用模式。

  • 约束限制：当前只支持设置ha。

  • 取值范围：ha。

  • 默认取值：不涉及。

status

String

  • 参数解释：ESW实例的状态。

  • 约束限制：不涉及。

  • 取值范围：

    • active：运行中

    • failed：创建失败

    • abnormal：异常

    • build：创建中

    • frozen：已冻结

  • 默认取值：不涉及。

created_at

String

  • 参数解释：ESW实例创建时间。

  • 约束限制：UTC时间，格式为yyyy-MM-ddTHH:mm:ss。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

updated_at

String

  • 参数解释：ESW实例更新时间。

  • 约束限制：UTC时间，格式为yyyy-MM-ddTHH:mm:ss。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

description

String

  • 参数解释：ESW实例描述信息。

  • 约束限制：

    • 长度范围为0~255个字符。

    • 不能包含“<”和“>”。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

tunnel_info

TunnelInfoResult object

  • 参数解释：本端隧道信息。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

charge_infos

PostPaidChargeInfos object

  • 参数解释：计费信息。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

availability_zones

AvailabilityZones object

  • 参数解释：ESW实例节点所在的可用区。

  • 约束限制：不涉及。

  • 取值范围：当前区域可用区。

  • 默认取值：不涉及。
表6 TunnelInfoResult

参数

参数类型

描述

vpc_id

String

  • 参数解释：ESW所在VPC资源ID。

  • 约束限制：

    • 需要使用本租户下可操作的VPC资源的ID。

    • 带“-”的UUID格式。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

virsubnet_id

String

  • 参数解释：ESW所在隧道子网ID。

  • 约束限制：

    • 需要使用本租户下可操作的子网资源的ID；此值即为子网详情中的“网络ID”参数值。

    • 带“-”的UUID格式。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

tunnel_ip

String

  • 参数解释：ESW实例的本端隧道IP。

  • 约束限制：不能与已存在的子网IP冲突。

  • 取值范围：标准的IPv4格式，例：192.168.1.1。

  • 默认取值：不涉及。

tunnel_port

Integer

  • 参数解释：ESW实例的隧道端口。

  • 约束限制：不涉及。

  • 取值范围：4789。

  • 默认取值：不涉及。

tunnel_type

String

  • 参数解释：ESW实例的隧道协议类型。

  • 约束限制：不涉及。

  • 取值范围：vxlan。

  • 默认取值：不涉及。
表7 PostPaidChargeInfos

参数

参数类型

描述

charge_mode

String

  • 参数解释：付费方式（后付费，即按需付费）。

  • 约束限制：不涉及。

  • 取值范围：postPaid,后付费，即按需付费。

  • 默认取值：不涉及。
表8 AvailabilityZones

参数

参数类型

描述

primary

String

  • 参数解释：ESW实例默认主节点所在的可用区。

  • 约束限制：1-128字符。

  • 取值范围：当前区域可用区id。

  • 默认取值：不涉及。

standby

String

  • 参数解释：ESW实例默认备节点所在的可用区。

  • 约束限制：1-128字符。

  • 取值范围：当前区域可用区id。

  • 默认取值：不涉及。

请求示例

PUT https://{endpoint}/v3/88104fcc62a640bfa0a0bf687607621c/l2cg/instances/16b2eea7-5935-445d-8410-083b7064b939

{
  "instance" : {
    "name" : "esw-online-update"
  }
}

响应示例

状态码：200

PUT操作正常返回，更多状态码请参见状态码。

{
  "request_id" : "14f6cf49525c604e5cb67a20d1404b5d",
  "instance" : {
    "name" : "esw-online-update",
    "id" : "16b2eea7-5935-445d-8410-083b7064b939",
    "region" : "cn-southwest-242",
    "status" : "active",
    "description" : null,
    "created_at" : "2025-05-20T07:51:52Z",
    "updated_at" : "2025-07-28T08:29:14Z",
    "project_id" : "88104fcc62a640bfa0a0bf687607621c",
    "flavor_ref" : "l2cg.small.ha",
    "ha_mode" : "ha",
    "availability_zones" : {
      "standby" : "cn-southwest-242a",
      "primary" : "cn-southwest-242a"
    },
    "charge_infos" : {
      "charge_mode" : "postPaid"
    },
    "tunnel_info" : {
      "vpc_id" : "41829b5e-66c0-4928-a3d4-f4570ce81d8f",
      "virsubnet_id" : "71f74174-c3fb-4929-9207-a4256b19e280",
      "tunnel_ip" : "192.168.0.76",
      "tunnel_port" : 4789,
      "tunnel_type" : "vxlan"
    }
  }
}

状态码

状态码

描述

200

PUT操作正常返回，更多状态码请参见状态码。

错误码

请参见错误码。

父主题： 企业交换机

相关文档