DescribeVSwitches - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Queries a list of vSwitches that are deployed in a specified virtual private cloud (VPC) in a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
VpcId	string	Yes	The VPC ID.	vpc-bp17gig441u0msmd78****

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
TotalCount	integer	The total number of vSwitches that are deployed in the VPC in the region. This parameter is optional and is not returned by default.	10
RequestId	string	The request ID.	BD65C0AD-D3C6-48D3-8D93-38D2015C****
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	“”
MaxResults	integer	The maximum number of entries returned.	10
VSwitches	object []	The available vSwitches.
VpcId	string	The ID of the VPC to which the vSwitch belongs.	vpc-bp17gig441u0msmd6****
VSwitchId	string	The vSwitch ID.	vsw-bp1g24p9no0iqir46****
Status	string	The state of the vSwitch. Valid values: `Pending`: The vSwitch is being configured. `Available`: The vSwitch is available.	Available
IsDefault	boolean	Indicates whether the vSwitch is the default vSwitch. Valid values: `true` `false`	false
VSwitchName	string	The name of the vSwitch.	vsw-test
ZoneId	string	The zone to which the switch belongs.	cn-hangzhou-k

Examples

Sample success responses

JSONformat

{
  "TotalCount": 10,
  "RequestId": "BD65C0AD-D3C6-48D3-8D93-38D2015C****",
  "NextToken": "“”",
  "MaxResults": 10,
  "VSwitches": [
    {
      "VpcId": "vpc-bp17gig441u0msmd6****",
      "VSwitchId": "vsw-bp1g24p9no0iqir46****",
      "Status": "Available",
      "IsDefault": false,
      "VSwitchName": "vsw-test",
      "ZoneId": "cn-hangzhou-k"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-04-12

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.