Queries the detailed information about a specified vSwitch.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeVSwitchAttributes

The operation that you want to perform. Set the value to DescribeVSwitchAttributes.

VSwitchId String Yes vsw-25naue4g****

The ID of the vSwitch.

RegionId String No cn-hangzhou

The region ID of the virtual private cloud (VPC) to which the route table belongs.

You can call the DescribeRegions operation to query the most recent region list.

DryRun Boolean No true

Specifies whether to check the request without performing the operation. Valid values:

  • true: checks the request without performing the operation. The system checks the required parameters, request syntax, and limits. If the request fails the check, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the request. If the request passes the check, a 2xx HTTP status code is returned and the operation is performed.

Response parameters

Parameter Type Example Description
VpcId String vpc-257gq642n****

The ID of the VPC to which the vSwitch belongs.

Status String Pending

The status of the vSwitch. Valid values:

  • Pending: being configured
  • Available: available
CreationTime String 2021-08-22T10:40:25Z

The time when the vSwitch was created.

IsDefault Boolean false

Indicates whether the vSwitch is the default vSwitch.

AvailableIpAddressCount Long 12

The number of available IP addresses.

NetworkAclId String 1

The network access control list (ACL) rules.

OwnerId Long 287683832402436789

The ID of the Alibaba Cloud account to which the vSwitch belongs.

VSwitchId String vsw-25b7pv15t****

The ID of the vSwitch.

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

The ID of the request.

CidrBlock String 192.168.0.1/24

The CIDR block of the vSwitch.

Description String abc

The description of the vSwitch.

ResourceGroupId String rg-acfmxazb4ph****

The ID of the resource group.

ZoneId String cn-beijing-a

The ID of the zone to which the vSwitch belongs.

Ipv6CidrBlock String 2408:4004:0:29xx::/64

The IPv6 CIDR block of the vSwitch.

VSwitchName String test

The name of the vSwitch.

RouteTable Object

The information about the route table that is associated with the vSwitch.

RouteTableId String vtb-bp145q7glnuzdv****

The ID of the route table.

RouteTableType String System

The type of the route table. Valid values:

  • System: a system route table
  • Custom: a custom route table

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeVSwitchAttributes
&ResourceOwnerId=287683832402436789
&VSwitchId=vsw-25naue4g****
&RegionId=cn-hangzhou
&DryRun=true
&Common request parameters

Sample success responses

XML format

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:4004:0:29xx::/64</Ipv6CidrBlock>
    <VSwitchName>test</VSwitchName>
    <RouteTable>
        <RouteTableId>vtb-bp145q7glnuzdv****</RouteTableId>
        <RouteTableType>System</RouteTableType>
    </RouteTable>
</DescribeVSwitchAttributesResponse>

JSON format

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:4004:0:29xx::/64",
  "VSwitchName" : "test",
  "RouteTable" : {
    "RouteTableId" : "vtb-bp145q7glnuzdv****",
    "RouteTableType" : "System"
  }
}

Error codes

For a list of error codes, visit the API Error Center.