Modifies an endpoint of an ApsaraDB for Redis instance.

For more information about how to modify an endpoint in the ApsaraDB for Redis console, see Modify connection addresses.

Debugging

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.

CurrentConnectionString String Yes r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com

The current endpoint of the ApsaraDB for Redis instance.
DBInstanceId String Yes r-bp1zxszhcgatnx****

The ID of the ApsaraDB for Redis instance.
NewConnectionString String No standardredis

The prefix of the new endpoint. The new endpoint of the ApsaraDB for Redis instance must be in the <prefix>.redis.rds.aliyuncs.com format. The prefix of the endpoint must start with a lowercase letter and can contain lowercase letters and digits. The prefix must be 8 to 64 characters in length.

Note One of the request parameters NewConnectionString and Port must be specified.
IPType String No Public

The network type of the endpoint. Valid values:

  • Private: the internal network.
  • Public: the Internet.
Port String No 6379

The port number of the ApsaraDB for Redis instance. Valid values: 1024 to 65535.

Note Either NewConnectionString or Port must be specified.
RegionId String No cn-hangzhou

The ID of the region where the instance is deployed.

Response parameters

Parameter Type Example Description
RequestId String 1790D68A-465C-44E3-BC24-9732652961F9

The ID of the request.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=ModifyDBInstanceConnectionString
&CurrentConnectionString=r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
&DBInstanceId=r-bp1zxszhcgatnx****
&NewConnectionString=standardredis
&<Common request parameters>

Sample success responses

XML format 

<ModifyDBInstanceConnectionStringResponse>
	  <RequestId>1790D68A-465C-44E3-BC24-9732652961F9</RequestId>
</ModifyDBInstanceConnectionStringResponse>

JSON format 

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

Error codes

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