Use ModifyDBInstanceConnectionString to change the endpoint or port of an instance - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Operation description

You can also modify the endpoint or port number in the Tair (Redis OSS-compatible) console. For more information, see Change the endpoint or port number of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:ModifyDBInstanceConnectionString

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance.	r-bp1zxszhcgatnx****
NewConnectionString	string	No	The prefix of the new endpoint in the `<prefix>.redis.rds.aliyuncs.com` format. The prefix must be 8 to 40 characters in length, can contain lowercase letters and digits, and must start with a lowercase letter. Note You must specify one of the NewConnectionString and Port parameters.	standardredis123
CurrentConnectionString	string	Yes	The current endpoint of the instance.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
Port	string	No	The port number of the instance. Valid values: 1024 to 65535. Note You must specify one of the NewConnectionString and Port parameters.	6379
IPType	string	No	The network type of the endpoint. Valid values: Private: internal network Public: Internet	Public

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	1790D68A-465C-44E3-BC24-9732652961F9

Examples

Success response

JSON format

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

Error response

JSON format

{
	"code": "200",
	"data": {
		"RequestId": "A7CCD05D-74FE-44DE-A4F0-C3EE58A252BE"
	},
	"successResponse": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	NewConnectionStringNotSupport	Specified newConnectionString is not supported.
400	InvalidIPType.Format	Specified parameter IPType is not supported.
400	InvalidConnectionStringOrPort.Duplicate	Specified connection string or port want to be modified is the same with current net type.	The connection string or port already exists.
400	InvalidConnectionString.Format	Specified connection string is not valid.	The connection string is invalid. Use a different one.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.