ModifyDBClusterVip - AnalyticDB - Alibaba Cloud Documentation Center

Changes the virtual IP address (VIP) that is used to connect to an AnalyticDB for MySQL cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:ModifyDBClusterVip	update	*DBCluster `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL Data Lakehouse Edition clusters within a region, including cluster IDs.	amv-2ze8mbuai97*****
VPCId	string	Yes	The VPC ID. Note The new VPC must reside in the same region as the cluster.	vpc-bp1at5ze0t5u3xtqn****
VSwitchId	string	Yes	The vSwitch ID. Note The new vSwitch must reside in the same zone as the cluster.	vsw-bp1aadw9k19x6cis9****
ConnectString	string	No	The endpoint of the cluster.	amv-2ze8mbuai974s4y2500000169.ads.aliyuncs.com

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AD222E9-****-4A42-BF6D-8A4442913CEF

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	ACS.Cluster.InvalidState	The state of the cluster does not support this operation.	The status of the cluster does not support the current operation.
400	InvalidConnectionString.Malformed	The specified parameter "ConnectionString" is not valid.	The specified parameter "ConnectionString" is not valid.
400	InvalidConnectionString.UnSupported	The specified parameter "ConnectionString" Only support vpc address.	Parameter ConnectString only supports VPC addresses
400	ACS.InvalidParameter.%s	Parameter %s is invalid.	The specified parameter is invalid.
400	ACS.UnsupportedAvailableZone	The specified available zone is not supported.	-
403	ACS.ServerError	ADB Cloud Service failed to process your request.	An internal service error occurred.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

For a list of error codes, visit the Service error codes.