全部产品
Search

搜索本产品

    专有网络 VPC：DescribeVSwitchAttributes - 查询指定交换机的配置信息

    文档中心

    专有网络 VPC：DescribeVSwitchAttributes - 查询指定交换机的配置信息

    更新时间：Nov 27, 2024

    调用DescribeVSwitchAttributes接口查询指定交换机的配置信息。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    VSwitchIdstring是

    要查询的交换机 ID。

    		vsw-25naue4g****
    RegionIdstring否

    路由表所属的 VPC 的地域 ID。

    您可以通过调用 DescribeRegions 接口获取地域 ID。

    		cn-hangzhou
    DryRunboolean否

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

    • true：发送检查请求，不会查询交换机的配置信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
    • false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接查询交换机的配置信息。
    		false

    返回参数

    名称类型描述示例值
    object

    交换机的详细信息。

    VpcIdstring

    交换机所属的 VPC ID。

    		vpc-257gq642n****
    Statusstring

    交换机的状态，取值：

    • Pending：配置中。

    • Available：可用。

    		Pending
    CreationTimestring

    交换机的创建时间。

    		2021-08-22T10:40:25Z
    IsDefaultboolean

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

    • true：默认交换机。
    • false：非默认交换机。
    		false
    AvailableIpAddressCountlong

    可用 IP 数量。

    		12
    NetworkAclIdstring

    网络 ACL 规则。

    		1
    OwnerIdlong

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

    		28768383240243****
    VSwitchIdstring

    交换机的 ID。

    		vsw-25b7pv15t****
    RequestIdstring

    请求 ID。

    		7B48B4B9-1EAD-469F-B488-594DAB4B6A1A
    CidrBlockstring

    交换机的私网地址范围。

    		192.168.0.1/24
    Descriptionstring

    交换机的描述。

    		abc
    ResourceGroupIdstring

    资源组 ID。

    		rg-acfmxazb4ph****
    ZoneIdstring

    交换机的所属可用区。

    		cn-beijing-a
    Ipv6CidrBlockstring

    交换机的 IPv6 网段。

    		2408:XXXX:3c5:44e::/64
    VSwitchNamestring

    交换机名称。

    		test
    ShareTypestring

    交换机的共享类型。

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

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

    • true：开启。
    • false：不开启。
    		true
    RouteTableobject

    交换机的路由表信息。

    RouteTableIdstring

    交换机关联的路由表 ID。

    		vtb-bp145q7glnuzdv****
    RouteTableTypestring

    路由表类型。取值：

    • System：系统路由表。

    • Custom：自定义路由表。

    		System
    Tagsarray<object>

    标签列表信息。

    Tagobject

    标签列表信息。

    Keystring

    标签键。

    		FinanceDept
    Valuestring

    标签值。

    		FinanceJoshua

    示例

    正常返回示例

    JSON格式

    {
  "VpcId": "vpc-257gq642n****",
  "Status": "Pending",
  "CreationTime": "2021-08-22T10:40:25Z",
  "IsDefault": false,
  "AvailableIpAddressCount": 12,
  "NetworkAclId": "1",
  "OwnerId": 0,
  "VSwitchId": "vsw-25b7pv15t****",
  "RequestId": "7B48B4B9-1EAD-469F-B488-594DAB4B6A1A",
  "CidrBlock": "192.168.0.1/24",
  "Description": "abc",
  "ResourceGroupId": "rg-acfmxazb4ph****",
  "ZoneId": "cn-beijing-a",
  "Ipv6CidrBlock": "2408:XXXX:3c5:44e::/64",
  "VSwitchName": "test",
  "ShareType": "Shared",
  "EnabledIpv6": true,
  "RouteTable": {
    "RouteTableId": "vtb-bp145q7glnuzdv****",
    "RouteTableType": "System"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息
    400InvalidVSwitchId.NotFoundSpecified VSwitch can not found.

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

    变更历史

    变更时间变更内容概要操作
    2023-07-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-05-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情