All Products
Search

This Product

    ApsaraDB RDS:ModifyDBInstanceConnectionString

    Document Center

    ApsaraDB RDS:ModifyDBInstanceConnectionString

    Last Updated:May 29, 2023

    Changes the endpoint and port of an instance.

    Operation Description

    ApsaraDB RDS provides the internal and public endpoints. ApsaraDB RDS also allows hybrid access by using both a virtual private cloud (VPC) endpoint and a classic network endpoint.

    Note

    • You can change only the prefix of an endpoint.

    • The read/write splitting endpoint cannot be changed.

    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
    rds:ModifyDBInstanceConnectionStringWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    		rm-uf6wjk5****
    CurrentConnectionStringstringYes

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

    NoteThe read/write splitting endpoint cannot be changed.
    		rm-uf6wjk5x****.mysql.rds.aliyuncs.com
    ConnectionStringPrefixstringYes

    The prefix of the endpoint after the change. Only the prefix of the value of CurrentConnectionString can be changed.

    NoteThe value must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-). The value cannot contain any of the following special characters: ! # % ^ & * = + | {} ; : ' " ,<> / ?
    		rm-****
    PortstringYes

    The port number after the change.

    		3306
    BabelfishPortstringNo

    The Tabular Data Stream (TDS) port of the instance for which Babelfish is enabled.

    NoteThis parameter applies only to ApsaraDB RDS for PostgreSQL instances. For more information about Babelfish for ApsaraDB RDS for PostgreSQL, see Introduction to Babelfish.
    		1433
    GeneralGroupNamestringNo

    The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.

    		rgc-bp1tkv8****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		65BDA532-28AF-4122-AA39-B382721EEE64

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400DnsConflictDns is conflict with other custins.The DNS server conflicts with other clients.
    400InvalidConnectionString.MalformedThe specified parameter ConnectionStringPrefix is not valid.-
    400OperationDenied.DBInstanceStatusThe operation is not permitted due to status of instance.The instance status does not support the operation.
    400InvalidConnectionString.NotFoundThe specified connection string or network type is not found.The endpoint cannot be found. Check the endpoint.
    400MissingConnectionStringThe request is missing a ConnectionString parameter.You must specify ConnectionString.
    400OtherEndpoint.ExistOther endpoint exist.The prefix of the public endpoint already exists.
    400Endpoint.NotFoundSpecified endpoint is not found.The port that is associated with the dedicated proxy endpoint cannot be found.
    404InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.The endpoint is duplicate. Specify a different endpoint.

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

    Change history

    Change timeSummary of changesOperation
    2022-09-01The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
    2022-06-23The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
    2022-04-25The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
    2022-04-25The error codes of the API operation change.,The input parameters of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: BabelfishPort