All Products
Search
Document Center

ENS:ModifyVSwitchAttribute

Last Updated:Mar 27, 2026

Modifies information about a vSwitch.

Operation description

  • Rate limit: 100 requests per second.

  • up to 5 times per second per user.

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:ModifyVSwitchAttribute

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

VSwitchId

string

Yes

The ID of the vSwitch.

n-****

VSwitchName

string

No

The name of the vSwitch.

  • The name must be 2 to 128 characters in length and can contain letters, digits, colons (:), underscores (_), and hyphens (-).

  • It must start with a letter but cannot start with http:// or https://.

Test-switch

Description

string

No

The description of the listener.

  • 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 first vswitch

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter InvalidParameter
400 InvalidVSwitchId.NotFound The specified VSwitchId does not exist.
400 ens.interface.error An error occurred while calling the API.
400 NoPermission Permission denied.
400 InvalidParameter.%s The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.