All Products
Search

This Product

    AnalyticDB:ModifyDBClusterVip

    Document Center

    AnalyticDB:ModifyDBClusterVip

    Last Updated:Aug 28, 2026

    Changes the virtual IP address (VIP) used to connect to an AnalyticDB for MySQL 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

    adb:ModifyDBClusterVip

    update

    *DBCluster

    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The ID of the AnalyticDB for MySQL Data Warehouse Edition cluster.

    Note

    Call the DescribeDBClusters operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition clusters in a region.

    am-2ze8mbuai97*****
    VPCId

    string

    Yes

    The virtual private cloud (VPC) ID of the cluster.

    vpc-bp1at5ze0t5u3xtqn****
    VSwitchId

    string

    Yes

    The vSwitch ID of the cluster.

    vsw-bp1aadw9k19x6cis9****
    ConnectionString

    string

    No

    The internal or public endpoint for which the server certificate needs to be created or updated.

    am-2ze8mbuai974s4y2500000169.ads.aliyuncs.com
    RegionId

    string

    No

    The region ID of the cluster.

    cn-beijing

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

    1AD222E9-****-4A42-BF6D-8A4442913CEF
    TaskId

    string

    The task ID.

    1564657730

    Examples

    Success response

    JSON format

    {
  "RequestId": "1AD222E9-****-4A42-BF6D-8A4442913CEF",
  "TaskId": "1564657730"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId does not exist. Verify that the DBClusterId value is valid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.