Use CreateVSwitch to create a vSwitch - ENS - Alibaba Cloud - ENS

Creates a VSwitch.

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

ens:CreateVSwitch

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	Yes	The ID of the ENS node.	cn-xian-unicom
CidrBlock	string	Yes	The CIDR block of the VSwitch. The following requirements apply: The prefix length must be an integer from 16 to 29. The CIDR block of the VSwitch must be a subset of the CIDR block of the VPC to which the VSwitch belongs. The CIDR block of the VSwitch cannot be the same as the destination CIDR block of an existing route in the VPC, but it can be a subset of the destination CIDR block.	172.16.0.0/24
VSwitchName	string	No	The name of the VSwitch. The following requirements apply: The name must be 2 to 128 characters in length. The name must start with a letter or a Chinese character, and cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (_), and hyphens (-). Default value: an empty string.	Test vSwitch
Description	string	No	The description of the VSwitch. The description must be 2 to 256 characters in length. It must start with a letter or a Chinese character, and cannot start with `http://` or `https://`.	This is my vswitch.
NetworkId	string	No	The ID of the network to which the VSwitch belongs.	n-257gqcdfvx6n****
Tag	array<object>	No	The tags of the resource. You can specify up to 20 tags.
	object	No	A resource tag.
Key	string	No	The key of the tag. The tag key cannot start with `aliyun`, `acs:`, `http://`, or `https://`. The tag key can be up to 64 characters long. The tag key cannot be an empty string.	team
Value	string	No	The value of the tag. It can be up to 128 characters long, can be an empty string, and cannot start with `acs:` or contain `http://` or `https://`.	Deep

Response elements

Element	Type	Description	Example
	object	The response parameters.
VSwitchId	string	The ID of the VSwitch.	vsw-5****
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984

Examples

Success response

JSON format

{
  "VSwitchId": "vsw-5****",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.
400	NetworkNotFound	The specified network is not found.	Network not found, please check network id.
400	IncorrectStatus.Network	The status of the network is incorrect.	The status of the network is incorrect.
400	QuotaExceeded	The number of resources has reached the quota limit.	The number of resources has reached the quota limit.
400	Network.SecondaryCidrNotFound	The network secondary CIDR is not found.
400	VSwitch.Ipv6CidrBlockOverlapped	The specified IPv6 CIDR block overlaps with existing vSwitches.
400	VSwitch.CidrBlockOverlapped	The specified CIDR block overlaps with existing vswitches.
400	VSwitch.InvalidIpv6CidrBlock	Invalid IPv6 CIDR value.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.