Modifies the endpoint and port of an ApsaraDB for RDS instance.

ApsaraDB for RDS provides the internal and public endpoints. It allows hybrid access by using both a VPC endpoint and a classic network endpoint.

  • You can modify only the prefix of an endpoint.
  • The read/write splitting endpoint cannot be modified.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyDBInstanceConnectionString

The operation that you want to perform. Set the value to ModifyDBInstanceConnectionString.

ConnectionStringPrefix String Yes rm-xxxxxx

The prefix of the endpoint. Only the prefix of the CurrentConnectionString parameter value can be modified.

Note The prefix must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). It cannot contain Chinese characters and special characters ~!#%^&*=+\|{};:'",<>/?
CurrentConnectionString String Yes

The endpoint of the instance. It can be an internal endpoint, a public endpoint, or a classic network endpoint in the hybrid access mode.

Note The read/write splitting endpoint cannot be modified.
DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

Port String Yes 3306

The port of the database service.

Response parameters

Parameter Type Example Description
RequestId String 65BDA532-28AF-4122-AA39-B382721EEE64

The ID of the request.


Sample requests

http(s):// Action=ModifyDBInstanceConnectionString
&<Common request parameters>

Sample success responses

XML format


JSON format

  "RequestId": " 65BDA532-28AF-4122-AA39-B382721EEE64"

Error codes

For a list of error codes, visit the API Error Center.