DescribeVSwitches - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Queries vSwitches in a specified region and VPC.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicemesh:DescribeVSwitches

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	Schema of Response
TotalCount	integer	The total number of entries returned. This parameter is optional and is not returned by default.	10
RequestId	string	The request ID.	BD65C0AD-D3C6-48D3-8D93-38D2015C****
NextToken	string	The token that is used to retrieve the next page of results. If this parameter is empty, all results have been returned.	“”
MaxResults	integer	The maximum number of entries to return for this request.	10
VSwitches	array<object>	The list of available vSwitches.
	object	An available vSwitch.
VpcId	string	The ID of the VPC to which the vSwitch belongs.	vpc-bp17gig441u0msmd6****
VSwitchId	string	The vSwitch ID.	vsw-bp1g24p9no0iqir46****
Status	string	The status 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`: The vSwitch is the default vSwitch. `false`: The vSwitch is not the default vSwitch.	false
VSwitchName	string	The name of the vSwitch.	vsw-test
ZoneId	string	The zone to which the vSwitch belongs.	cn-hangzhou-k

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.