Use CreateVSwitch to create a vSwitch - ENS

A vSwitch is created.

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 edge node.	cn-xian-unicom
CidrBlock	string	Yes	The CIDR block of the vSwitch. Take note of the following limits: The subnet mask must be 16 to 29 bits in length. The CIDR block of the vSwitch must fall within 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 in a route entry of the VPC. However, it can be a subset of the destination CIDR block.	172.16.0.0/24
VSwitchName	string	No	The name of the vSwitch. The name must meet the following requirements: The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-). Default value: null.	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 but cannot start with http:// or https://.	This is my vswitch.
NetworkId	string	No	The ID of the network to which the vSwitch that you want to create belongs.	n-257gqcdfvx6n****
Tag	array<object>	No	The tags.
	object	No	The tag to add to the resource.
Key	string	No	The key of the tag that are to add to the instance. Valid values of N: 1 to 20. The key cannot start with `aliyun`, `acs:`, `http://`, or `https://`. The key must be up to 64 characters in length. The tag key cannot be an empty string.	team
Value	string	No	The value of tag N that is added to the resource. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with acs: or contain http:// or https://.	Deep

Response elements

Element	Type	Description	Example
	object
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	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	InvalidSecurityGroupId.NotFound	The specified SecurityGroupId does not exist.	The specified security group ID does not exist.
400	SecurityGroupRuleConflict.Duplicated	The SecurityGroup rule already exists.	duplicate security group rules.
400	AuthorizationLimitExceed	The limit of authorization records in the security group reaches.	The number of security group rules exceeds the limit.
400	ens.interface.error	An error occurred while calling the API.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.