DescribeAccessInstanceVSwitchList-阿里云帮助中心

Queries the vSwitches for synchronization nodes.

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

yundun-cloudfirewall:DescribeAccessInstanceVSwitchList

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionNo	string	Yes	The region ID.	cn-hangzhou
VpcId	string	No	The ID of the VPC.	vpc-uf6b5lyul0x******
ZoneId	string	No	The zone ID.	cn-hangzhou-i
VSwitchId	string	No	The ID of the vSwitch.	vsw-qzeaol304m***
MemberUid	integer	No	The UID of the Alibaba Cloud account to which the resource belongs.	135809047715****
PageNo	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	450D47F5-956E-543E-8502-2F71C8C54E72
TotalCount	integer	The total number of entries.	1
PageNo	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Zones	array<object>	The list of zones.
	array<object>	A zone.
ZoneId	string	The zone ID.	cn-hangzhou-i
VSwitchList	array<object>	The list of vSwitches.
	object	A vSwitch.
VpcId	string	The ID of the VPC to which the vSwitch belongs.	vpc-uf6b5lyul0x******
VSwitchId	string	The ID of the vSwitch.	vsw-qzeaol304m***
VSwitchName	string	The name of the vSwitch.	ManagedVSW
CidrBlock	string	The IPv4 CIDR block of the vSwitch.	192.168.0.0/16
AvailableIpAddressCount	integer	The number of available IP addresses in the vSwitch.	254
FirewallVSwitch	boolean	Indicates whether the vSwitch is in a VPC that is managed by Cloud Firewall.	false

Examples

Success response

JSON format

{
  "RequestId": "450D47F5-956E-543E-8502-2F71C8C54E72",
  "TotalCount": 1,
  "PageNo": 1,
  "PageSize": 10,
  "Zones": [
    {
      "ZoneId": "cn-hangzhou-i",
      "VSwitchList": [
        {
          "VpcId": "vpc-uf6b5lyul0x******",
          "VSwitchId": "vsw-qzeaol304m***",
          "VSwitchName": "ManagedVSW",
          "CidrBlock": "192.168.0.0/16",
          "AvailableIpAddressCount": 254,
          "FirewallVSwitch": false
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.