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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeVSwitchAttributes

系统规定参数。取值:DescribeVSwitchAttributes

VSwitchId String vsw-25naue4g****

要查询的交换机ID。

RegionId String cn-hangzhou

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

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

DryRun Boolean false

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

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

返回数据

名称 类型 示例值 描述
VpcId String vpc-257gq642n****

交换机所属的VPC ID。

Status String Pending

交换机的状态,取值:

  • Pending:配置中。
  • Available:可用。
CreationTime String 2021-08-22T10:40:25Z

交换机的创建时间。

IsDefault Boolean false

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

  • true:默认交换机。
  • false:非默认交换机。
AvailableIpAddressCount Long 12

可用IP数量。

NetworkAclId String 1

网络ACL规则。

OwnerId Long 287683832402436789

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

VSwitchId String vsw-25b7pv15t****

交换机的ID。

RequestId String 7B48B4B9-1EAD-469F-B488-594DAB4B6A1A

请求ID。

CidrBlock String 192.168.0.1/24

交换机的私网地址范围。

Description String abc

交换机的描述。

ResourceGroupId String rg-acfmxazb4ph****

资源组ID。

ZoneId String cn-beijing-a

交换机的所属可用区。

Ipv6CidrBlock String 2408:XXXX:3c5:44e::/64

交换机的IPv6网段。

VSwitchName String test

交换机名称。

RouteTable Object

交换机的路由表信息。

RouteTableId String vtb-bp145q7glnuzdv****

交换机关联的路由表ID。

RouteTableType String System

路由表类型。取值:

  • System:系统路由表。
  • Custom:自定义路由表。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVSwitchAttributes
&VSwitchId=vsw-25naue4g****
&RegionId=cn-hangzhou
&DryRun=false
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVSwitchAttributesResponse>
    <VpcId>vpc-257gq642n****</VpcId>
    <Status>Pending</Status>
    <CreationTime>2021-08-22T10:40:25Z</CreationTime>
    <IsDefault>false</IsDefault>
    <AvailableIpAddressCount>12</AvailableIpAddressCount>
    <NetworkAclId>1</NetworkAclId>
    <OwnerId>287683832402436800</OwnerId>
    <VSwitchId>vsw-25b7pv15t****</VSwitchId>
    <RequestId>7B48B4B9-1EAD-469F-B488-594DAB4B6A1A</RequestId>
    <CidrBlock>192.168.0.1/24</CidrBlock>
    <Description>abc</Description>
    <ResourceGroupId>rg-acfmxazb4ph****</ResourceGroupId>
    <ZoneId>cn-beijing-a</ZoneId>
    <Ipv6CidrBlock>2408:XXXX:3c5:44e::/64</Ipv6CidrBlock>
    <VSwitchName>test</VSwitchName>
    <RouteTable>
        <RouteTableId>vtb-bp145q7glnuzdv****</RouteTableId>
        <RouteTableType>System</RouteTableType>
    </RouteTable>
</DescribeVSwitchAttributesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "VpcId" : "vpc-257gq642n****",
  "Status" : "Pending",
  "CreationTime" : "2021-08-22T10:40:25Z",
  "IsDefault" : false,
  "AvailableIpAddressCount" : 12,
  "NetworkAclId" : "1",
  "OwnerId" : 287683832402436800,
  "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",
  "RouteTable" : {
    "RouteTableId" : "vtb-bp145q7glnuzdv****",
    "RouteTableType" : "System"
  }
}

错误码

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