All Products
Search
Document Center

AnalyticDB:ModifyClusterConnectionString

Last Updated:Nov 10, 2025

Modifies the public endpoint of an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints .

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:ModifyClusterConnectionStringupdate
*DBClusterLakeVersion
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

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

amv-bp11q28kvl688****
ConnectionStringPrefixstringYes

The prefix of the public endpoint.

  • The prefix can contain lowercase letters, digits, and hyphens (-). It must start with a lowercase letter.
  • The prefix can be up to 30 characters in length.
test-123
CurrentConnectionStringstringYes

The public endpoint of the AnalyticDB for MySQL Data Lakehouse Edition cluster.

amv-bp11q28kvl688****.ads.aliyuncs.com
PortintegerYes

The port number. Set the value to 3306.

3306

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

370D09FD-442A-5225-AAD3-7362CAE39177

Examples

Sample success responses

JSONformat

{
  "RequestId": "370D09FD-442A-5225-AAD3-7362CAE39177"
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe 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.

Change history

Change timeSummary of changesOperation
No change history