All Products
Search
Document Center

:ModifyDBClusterVpc

Last Updated:Sep 19, 2025

Modifies the VSwitch parameters for a cluster.

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

polardb:ModifyDBClusterVpc

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

 None None

Request parameters

Parameter

Type

Required

Description

Example
DBClusterId

string

Yes

The cluster ID.

pc-*************
VPCId

string

No

The ID of the virtual private cloud (VPC).

vpc-*******************
VSwitchId

string

Yes

The ID of the virtual switch.

vsw-**********
ExistedEndpointSwitchType

string

Yes

Specifies whether to switch existing endpoints. Valid values:

  • NONE: Does not switch existing endpoints.

  • ALL: Switches all existing endpoints.

NONE

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

EBEAA83D-1734-42E3-85E3-E25F6E******

Examples

Success response

JSON format

{ "RequestId": "EBEAA83D-1734-42E3-85E3-E25F6E******" }

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidVSwitchID.Malformed The specified parameter VSwitchId is not valid. The value specified for the VSwitchId parameter is invalid.
400 InvalidEndpointSwitchType.Malformed The specified parameter ExistedEndpointSwitchType is not valid. The specified ExistedEndpointSwitchType parameter is invalid.
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.