ModifyVSwitchAttribute - Elastic Compute Service - Alibaba Cloud Documentation Center

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - ModifyVSwitchAttribute for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

vpc:ModifyVSwitchAttribute

update

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

None

Request parameters

Parameter	Type	Required	Description	Example
VSwitchId	string	Yes	The ID of the VSwitch.
VSwitchName	string	No	The new name of the VSwitch. The name must be 2 to 128 characters in length. It must start with a letter and can contain letters, digits, underscores (_), and hyphens (-).
RegionId	string	No	The ID of the region where the VSwitch is located. You can call the `DescribeRegions` operation to query the most recent list of regions.
Description	string	No	The new description for the VSwitch. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The ID of the request.

Examples

Success response

JSON format

{
  "RequestId": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidDescription.Malformed	Invalid description.
400	InvalidVSwitchName.Malformed	Specified virtual switch name is not valid.	The vSwitch name is invalid.
400	InvalidVSwitchDiscription.Malformed	Specified virtual switch description is not valid.	The specified vSwitch description is invalid.
400	Forbidden.VRouterNotFound	specified virtual switch is not found during access authentication.
404	InvalidVSwitchId.NotFound	The specified virtual switch does not exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.