DescribeVSwitches - 查询交换机信息_边缘节点服务 ENS(ENS)-阿里云帮助中心

调用DescribeVSwitches查询可组网的信息，内网按vswitch进行组网。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ens:DescribeVSwitches	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
EnsRegionId	string	否	ENS 节点 ID。	cn-xian-unicom
VSwitchId	string	否	交换机 ID。	vsw-5m9xhlq8oh***
VSwitchName	string	否	交换机名称。	testVSwitchName
NetworkId	string	否	要查询的交换机所属 VPC 的 ID。	vpc-25cdvfeq58pl****
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数，最大值为 50，默认值为 10。	10
EnsRegionIds	array	否	ENS 节点 ID 数组。数组长度：1~100。
	string	否	ENS 节点 ID 数组。	cn-chengdu-telecom-4
VSwitchIds	array	否	虚拟交换机 ID 数组。数组长度：1~100。
	string	否	虚拟交换机 ID 数组。	vsw-5****tzrpf

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageSize	integer	当前查询每页的行数。	2
PageNumber	integer	当前查询页码。	1
TotalCount	integer	列表数据总数。	3
VSwitches	array<object>	返回数据列表，详见返回示例（JSON 格式）VSwitch 对象数组。
VSwitch	object
EnsRegionId	string	ENS 节点 ID。	cn-xian-unicom
Status	string	交换机的状态，如下所示： Pending：配置中。 Available：可用。	Pending
FreeIpCount	long	可用 IP 数量。	1024
VSwitchId	string	交换机 ID。	vsw-5m9xhlq8oh***
CidrBlock	string	交换机的 IPv4 网段。	10.21.224.0/22
Description	string	交换机的描述信息。	VSwitchDescription
NetworkId	string	网络 ID。	vpc-25cdvfeq58pl****
CreatedTime	string	创建时间，使用 UTC 时间格式，格式为 yyyy-MM-ddTHH:mm:ssZ。	2020-06-16T06:33:15Z
VSwitchName	string	交换机名称。	testVSwitchName

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize": 2,
  "PageNumber": 1,
  "TotalCount": 3,
  "VSwitches": {
    "VSwitch": [
      {
        "EnsRegionId": "cn-xian-unicom",
        "Status": "Pending",
        "FreeIpCount": 1024,
        "VSwitchId": "vsw-5m9xhlq8oh***",
        "CidrBlock": "10.21.224.0/22",
        "Description": "VSwitchDescription",
        "NetworkId": "vpc-25cdvfeq58pl****",
        "CreatedTime": "2020-06-16T06:33:15Z",
        "VSwitchName": "testVSwitchName"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	NoPermission	Permission denied.	没有足够的权限，请联系云账号管理员授予您相应权限。
400	CallInterface	Call Interface Happen Error.	接口调用出错。
400	ens.interface.error	Failed to call API.	接口调用发生异常。
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-12-26	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-12-21	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情