# 查询ESW实例列表 - ListInstances #### 功能介绍 当您的ESW实例创建成功后，您可以通过调用此接口查询所有ESW实例的详细信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/esw/doc?api=ListInstances&version=v2)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-esw/esw_api0011.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | esw:instance:list | List | - | - | - | - | #### URI GET /v3/{project_id}/l2cg/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | - 参数解释：ESW实例所属项目ID。 - 约束限制：不涉及。 - 取值范围：不涉及。 - 默认取值：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | - 参数解释：ESW资源ID。ESW创建成功后，会生成一个ESW ID，是ESW对应的唯一标识。 - 约束限制：带"-"的UUID格式。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | name | 否 | String | - 参数解释：ESW实例的名称。 - 约束限制： - 长度范围为1\~64个字符。 - 名称由中文、英文字母、数字、下划线（_）、中划线（-）、点（.）组成。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | project_id | 否 | String | - 参数解释：ESW实例所属项目ID。 - 约束限制：不涉及。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | description | 否 | String | - 参数解释：ESW的描述信息。 - 约束限制： - 长度范围为0\~255个字符。 - 不能包含"\<"和"\>"。 - 取值范围：不涉及。 - 默认取值：不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | - 参数解释：请求的唯一标识。 - 约束限制：UUID格式。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | page_info | [PageInfo] object | - 参数解释：分页信息。 - 约束限制：不涉及。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | instances | Array of [Instance] objects | - 参数解释：查询实例列表响应体。 - 约束限制：不涉及。 - 取值范围：不涉及。 - 默认取值：不涉及。 | 表4PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | - 参数解释：当前页的最后一条记录，最后一页时无next_marker字段。 - 约束限制：不涉及。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | previous_marker | String | - 参数解释：分页查询起始的资源ID，为空时查询第一页。 - 约束限制：不涉及。 - 取值范围：不涉及。 - 默认取值：不涉及。 | | current_count | Integer | - 参数解释：当前页记录总数。 - 约束限制：不涉及。 - 取值范围：不涉及。 - 默认取值：不涉及。 | 表5Instance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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实例节点所在的可用区。 - 约束限制：不涉及。 - 取值范围：当前区域可用区。 - 默认取值：不涉及。 | 表6TunnelInfoResult | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。 - 默认取值：不涉及。 | 表7PostPaidChargeInfos | 参数 | 参数类型 | 描述 | |:---|:---|:---| | charge_mode | String | - 参数解释：付费方式（后付费，即按需付费）。 - 约束限制：不涉及。 - 取值范围：postPaid,后付费，即按需付费。 - 默认取值：不涉及。 | 表8AvailabilityZones | 参数 | 参数类型 | 描述 | |:---|:---|:---| | primary | String | - 参数解释：ESW实例默认主节点所在的可用区。 - 约束限制：1-128字符。 - 取值范围：当前区域可用区id。 - 默认取值：不涉及。 | | standby | String | - 参数解释：ESW实例默认备节点所在的可用区。 - 约束限制：1-128字符。 - 取值范围：当前区域可用区id。 - 默认取值：不涉及。 | #### 请求示例 ``` GET https://{endpoint}/v3/88104fcc62a640bfa0a0bf687607621c/l2cg/instances ``` #### 响应示例 **状态码：200** GET操作正常返回，更多状态码请参见[状态码](https://support.huaweicloud.com/api-esw/esw_api0020.html)。 ``` { "request_id" : "ca8bd3285faf5a0e600cc9e66032b4b9", "instances" : [ { "name" : "esw-offline-inter", "id" : "a14aa233-3ac1-4218-8d85-b168a6c1b6df", "region" : "cn-southwest-242", "status" : "active", "description" : null, "created_at" : "2025-05-27T09:12:50Z", "updated_at" : "2025-07-26T04:57:15Z", "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" : "a36e12f4-b490-4b85-bf41-dc61f8f4f4d7", "virsubnet_id" : "fb9dee2e-88eb-4fa8-b698-e089d29a56ee", "tunnel_ip" : "192.168.4.202", "tunnel_port" : 4789, "tunnel_type" : "vxlan" } }, { "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" } } ], "page_info" : { "previous_marker" : "a14aa233-3ac1-4218-8d85-b168a6c1b6df", "current_count" : 2 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET操作正常返回，更多状态码请参见[状态码](https://support.huaweicloud.com/api-esw/esw_api0020.html)。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-esw/ErrorCode.html)。