文档

DescribeVSwitches - 查询可组网信息

更新时间:

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeVSwitchesList
  • VSwitch
    acs:vpc:{#regionId}:{#accountId}:vswitch/*
  • vpc:VPC

请求参数

名称类型必填描述示例值
VpcIdstring

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

说明 RegionIdVpcId 参数至少输入一个。
vpc-25cdvfeq58pl****
VSwitchIdstring

要查询的交换机的 ID。

vsw-23dscddcffvf3****
ZoneIdstring

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

cn-hangzhou-d
RegionIdstring

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

说明 RegionIdVpcId 参数至少输入一个。
cn-hangzhou
VSwitchNamestring

交换机的名称。

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

vSwitch
DryRunboolean

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

  • true:发送检查请求,不会创建资源(接口功能)。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
true
IsDefaultboolean

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

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

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

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

true
RouteTableIdstring

路由表的 ID。

vtb-bp145q7glnuzdvzu2****
ResourceGroupIdstring

交换机所属的资源组 ID。

rg-bp67acfmxazb4ph****
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

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

10
VSwitchOwnerIdlong

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

2546073170691****
Tagobject []

资源的标签。

Keystring

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

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

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

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

返回的信息。

PageSizeinteger

每页包含的条目数。

10
RequestIdstring

请求 ID。

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

当前页码。

1
TotalCountinteger

列表条目数。

1
VSwitchesobject []

交换机的详细信息。

VpcIdstring

交换机所属 VPC 的 ID。

vpc-257gcdcdq64****
Statusstring

交换机的状态,取值:

  • Pending:配置中。

  • Available:可用。

Available
CreationTimestring

交换机的创建时间。

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

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

  • true:是默认交换机。

  • false:非默认交换机。

true
AvailableIpAddressCountlong

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

1
NetworkAclIdstring

网络 ACL 的 ID。

nacl-a2do9e413e0spzasx****
OwnerIdlong

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

253460731706911258
VSwitchIdstring

交换机的 ID。

vsw-25bcdxs7pv1****
CidrBlockstring

交换机的 IPv4 网段。

172.16.0.0/24
Descriptionstring

交换机的描述信息。

VSwitchDescription
ResourceGroupIdstring

交换机所属的资源组 ID。

rg-acfmxazb4ph6aiy****
ZoneIdstring

交换机所属的可用区。

cn-hangzhou-d
Ipv6CidrBlockstring

交换机的 IPv6 网段。

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

交换机的名称。

vSwitch
ShareTypestring

交换机的共享类型。

  • 取值为空时,表示该交换机为普通交换机。
  • 取值为 Shared 时,表示该交换机为共享交换机。
  • 取值为 Sharing 时,表示该交换机正在被他人共享。
Shared
EnabledIpv6boolean

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

  • true:开启。
  • false:不开启。
true
Tagsobject []

交换机标签信息。

Keystring

交换机绑定的标签键。

department
Valuestring

交换机绑定的标签值。

dev
RouteTableobject

路由表信息。

RouteTableIdstring

交换机关联的路由表 ID。

vrt-bp145q7glnuzdv****
RouteTableTypestring

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

  • 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": 253460731706911260,
        "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错误码错误信息描述
400Forbidden.VpcNotFoundSpecified VPC can not found.指定的VPC不存在,请您检查VPC是否正确。
400InvalidTagKeyThe tag keys are not valid.无效的标签索引
400InvalidTagValueThe tag values are not valid.无效的标签值
400IellgalParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.-
400IllegalParam.OwnerIdThe specified parameter VSwitchOwnerId is not valid.-
404InvalidVSwitchId.NotFoundVSwitch not exist.该交换机不存在,请您检查输入的交换机是否正确。
404InvalidVpcIdNumber.NotSupportedThe number of vpcIds exceeds the limit.vpcId数量超出限制
404InvalidVSwitchIdNumber.NotSupportedThe number of vSwitchIds exceeds the limit.-

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

变更历史

变更时间变更内容概要操作
2023-07-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
2023-07-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:Tag
2023-07-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
2023-05-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)