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

查询ESW实例详情 - ShowInstance

功能介绍

当您的ESW实例创建成功后，您可以通过调用此接口查询单个ESW实例的详细信息。

调试

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

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

esw:instance:get

Read

-

-

-

-

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

是

String

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

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

  • 取值范围：不涉及。

  • 默认取值：不涉及。

project_id

是

String

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

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

instance

Instance object

  • 参数解释：查询实例的响应体。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

request_id

String

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

  • 约束限制：UUID格式。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表3 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实例节点所在的可用区。

  • 约束限制：不涉及。

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

  • 默认取值：不涉及。
表4 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。

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

参数

参数类型

描述

charge_mode

String

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

  • 约束限制：不涉及。

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

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

参数

参数类型

描述

primary

String

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

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

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

  • 默认取值：不涉及。

standby

String

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

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

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

  • 默认取值：不涉及。

请求示例

GET https://{endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/l2cg/instances/0c98a940-acf1-4eaa-852e-f3f83b8f03e8

响应示例

状态码：200

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

{
  "instance" : {
    "name" : "esw",
    "id" : "9620118d-048b-4de7-96f9-a81adb2e8bc3",
    "region" : "cn-southwest-248",
    "status" : "active",
    "description" : "test",
    "created_at" : "2025-08-18T12:24:27Z",
    "updated_at" : "2025-08-22T07:46:11Z",
    "project_id" : "24908e6eda8547a4bee256c8a3b3e257",
    "flavor_ref" : "l2cg.large.ha",
    "ha_mode" : "ha",
    "availability_zones" : {
      "standby" : "cn-southwest-111a",
      "primary" : "cn-southwest-111a"
    },
    "charge_infos" : {
      "charge_mode" : "postPaid"
    },
    "tunnel_info" : {
      "vpc_id" : "2bbf1a14-fb12-4c8d-8720-59bbce1160d8",
      "virsubnet_id" : "159c16da-e66f-462e-b2ba-106b9e940820",
      "tunnel_ip" : "192.168.0.54",
      "tunnel_port" : 4789,
      "tunnel_type" : "vxlan"
    }
  },
  "request_id" : "90016460759578d6b92588b536a13c13"
}

状态码

状态码

描述

200

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

错误码

请参见错误码。

父主题： 企业交换机

相关文档