All Products
Search
Document Center

AnalyticDB:ModifyClusterConnectionString

Last Updated:Aug 30, 2024

Changes the endpoint of an AnalyticDB for MySQL cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
am-bp18934i73vb****
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 current public endpoint of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusterNetInfo operation to query the public endpoint of the cluster.
am-bp18934i73vb****.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.