AI 助理
文档备案控制台
官方文档
首页

DescribeVSwitches - 查询可组网信息

更新时间：
复制 MD 格式
产品详情
我的收藏

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:DescribeVSwitches

list

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/*
  • vpc:VPC
 无

请求参数

名称

类型

必填

描述

示例值
VpcId

string

否

要查询的交换机所属 VPC 的 ID。

说明

RegionId 和 VpcId 参数至少输入一个。

vpc-25cdvfeq58pl****
VSwitchId

string

否

要查询的交换机的 ID。

vsw-23dscddcffvf3****
ZoneId

string

否

交换机所属可用区的 ID。您可以通过调用 DescribeZones 接口获取可用区 ID。

cn-hangzhou-d
RegionId

string

否

交换机所属地域的 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

说明

RegionId 和 VpcId 参数至少输入一个。

cn-hangzhou
VSwitchName

string

否

交换机的名称。

名称长度为 1～128 个字符，不能以http://或https://开头。

vSwitch
DryRun

boolean

否

是否只预检此次请求。取值：

  • true：发送检查请求，不会创建资源（接口功能）。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。

  • false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。

true
IsDefault

boolean

否

是否查询指定地域下的默认交换机，取值：

  • true：查询指定地域下的默认交换机。

  • false：不查询指定地域下的默认交换机。

如果不传入该参数，系统默认查询指定地域下的所有交换机。

true
RouteTableId

string

否

路由表的 ID。

vtb-bp145q7glnuzdvzu2****
ResourceGroupId

string

否

交换机所属的资源组 ID。

rg-bp67acfmxazb4ph****
PageNumber

integer

否

列表的页码，默认值为 1。

1
PageSize

integer

否

分页查询时每页的行数，最大值为 50。默认值为 10。

10
VSwitchOwnerId

integer

否

资源归属的阿里云账号 ID。

2546073170691****
EnableIpv6

boolean

否

是否查询指定地域下开启 IPv6 网段的交换机，取值：

  • true：查询指定地域下开启 IPv6 网段的交换机。

  • false：不查询指定地域下开启 IPv6 网段的交换机。

如果不传入该参数，系统默认查询指定地域下的所有交换机。

false
Tag

array<object>

否

资源的标签。

object

否

标签。

Key

string

否

资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。

一个标签键最多支持 128 个字符，不能以aliyun和acs:开头，不能包含http://或者https://。

FinanceDept
Value

string

否

资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。

最多支持 128 个字符，不能以aliyun和acs:开头，不能包含http://或者https://。

FinanceJoshua

返回参数

名称

类型

描述

示例值

object

返回的信息。

PageSize

integer

每页包含的条目数。

10
RequestId

string

请求 ID。

9A572171-4E27-40D1-BD36-D26C9E71E29E
PageNumber

integer

当前页码。

1
TotalCount

integer

列表条目数。

1
VSwitches

object

VSwitch

array<object>

交换机的详细信息。

array<object>

交换机数据结构体。

VpcId

string

交换机所属 VPC 的 ID。

vpc-257gcdcdq64****
Status

string

交换机的状态，取值：

  • Pending：配置中。

  • Available：可用。

Available
CreationTime

string

交换机的创建时间。

2022-01-18T12:43:57Z
IsDefault

boolean

是否是默认交换机。取值：

  • true：是默认交换机。

  • false：非默认交换机。

true
AvailableIpAddressCount

integer

交换机中可用的 IP 地址数量。

1
NetworkAclId

string

网络 ACL 的 ID。

nacl-a2do9e413e0spzasx****
OwnerId

integer

资源归属的阿里云账号 ID。

25346073170691****
VSwitchId

string

交换机的 ID。

vsw-25bcdxs7pv1****
CidrBlock

string

交换机的 IPv4 网段。

172.16.0.0/24
Description

string

交换机的描述信息。

VSwitchDescription
ResourceGroupId

string

交换机所属的资源组 ID。

rg-acfmxazb4ph6aiy****
ZoneId

string

交换机所属的可用区。

cn-hangzhou-d
Ipv6CidrBlock

string

交换机的 IPv6 网段。

2408:4002:10c4:4e03::/64
VSwitchName

string

交换机的名称。

vSwitch
ShareType

string

交换机的共享类型。

  • 取值为空时，表示该交换机为普通交换机。

  • 取值为 Shared 时，表示该交换机为共享交换机。

  • 取值为 Sharing 时，表示该交换机正在被他人共享。

Shared
EnabledIpv6

boolean

是否为交换机开启 IPv6 网段并配置交换机的 IPv6 网段。取值如下：

  • true：开启。

  • false：不开启。

true
Tags

object

Tag

array<object>

交换机标签信息。

object

标签信息数据结构体。

Key

string

交换机绑定的标签键。

department
Value

string

交换机绑定的标签值。

dev
RouteTable

object

路由表信息。

RouteTableId

string

交换机关联的路由表 ID。

vrt-bp145q7glnuzdv****
RouteTableType

string

交换机关联的路由表的类型：

  • System：系统路由表。

  • Custom：自定义路由表。

System

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "9A572171-4E27-40D1-BD36-D26C9E71E29E",
  "PageNumber": 1,
  "TotalCount": 1,
  "VSwitches": {
    "VSwitch": [
      {
        "VpcId": "vpc-257gcdcdq64****",
        "Status": "Available",
        "CreationTime": "2022-01-18T12:43:57Z",
        "IsDefault": true,
        "AvailableIpAddressCount": 1,
        "NetworkAclId": "nacl-a2do9e413e0spzasx****",
        "OwnerId": 0,
        "VSwitchId": "vsw-25bcdxs7pv1****",
        "CidrBlock": "172.16.0.0/24",
        "Description": "VSwitchDescription",
        "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
        "ZoneId": "cn-hangzhou-d",
        "Ipv6CidrBlock": "2408:4002:10c4:4e03::/64",
        "VSwitchName": "vSwitch",
        "ShareType": "Shared",
        "EnabledIpv6": true,
        "Tags": {
          "Tag": [
            {
              "Key": "department",
              "Value": "dev"
            }
          ]
        },
        "RouteTable": {
          "RouteTableId": "vrt-bp145q7glnuzdv****",
          "RouteTableType": "System"
        }
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述
400 Forbidden.VpcNotFound Specified VPC can not found. 指定的VPC不存在，请您检查VPC是否正确。
400 InvalidTagKey The tag keys are not valid. 无效的标签索引
400 InvalidTagValue The tag values are not valid. 无效的标签值
400 IellgalParameter.OwnerAccount The specified parameter OwnerAccount is not valid. 指定参数 OwnerAccount 不合法
400 IllegalParam.OwnerId The specified parameter VSwitchOwnerId is not valid.
400 InvalidVpcIdNumber.NotSupported The number of vpcIds exceeds the limit. vpcId数量超出限制
400 InvalidVSwitchIdNumber.NotSupported The number of vSwitchIds exceeds the limit.
400 Throttling.DeepPageSkip Deep page skip throttled. Please reduce the page skip frequency or use sequential pagination. 深分页跳页次数已触发限流。请降低深翻页跳页的频率，或使用顺序分页。
404 InvalidVSwitchId.NotFound VSwitch not exist.

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

变更历史

更多信息，参考变更详情。

上一篇：ModifyVSwitchAttribute - 修改指定交换机的配置信息下一篇：DescribeVSwitchAttributes - 查询指定交换机的配置信息