All Products
Document Center

ApsaraDB for Redis:ModifyDBInstanceConnectionString

Last Updated:Feb 20, 2024

Changes the endpoint or port number of an ApsaraDB for Redis instance.

Operation description

You can also modify the endpoint or port number of an instance in the ApsaraDB for Redis console. For more information, see Change the endpoint or port number of an instance.


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
  • DBInstance

Request parameters


The ID of the instance.


The prefix of the new endpoint. Specify the endpoint in the <prefix> format. The prefix must be 8 to 40 characters in length and can contain lowercase letters and digits. It must start with a lowercase letter.

Note You must specify one of the NewConnectionString and Port parameters.

The current endpoint of the instance.


The port number that is used to connect to the instance. Valid values: 1024 to 65535.

Note You must specify one of the NewConnectionString and Port parameters.

The network type of the endpoint. Valid values:

  • Private: internal network
  • Public: Internet

Response parameters


The ID of the request.



Sample success responses


  "RequestId": "1790D68A-465C-44E3-BC24-9732652961F9"

Error codes

HTTP status codeError codeError messageDescription
400NewConnectionStringNotSupportSpecified newConnectionString is not supported.-
400InvalidIPType.FormatSpecified parameter IPType is not supported.-
400InvalidConnectionStringOrPort.DuplicateSpecified connection string or port want to be modified is the same with current net type.The connection string or port already exists.
400InvalidConnectionString.FormatSpecified connection string is not valid.The connection string is invalid. Use a different one.

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