ModifyDBInstanceConnectionString - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Modifies the connection string and port of an ApsaraDB for MongoDB instance.

Operation description

You can modify the connection strings and ports of the following instances:

You can modify the connection strings of instances that use local or cloud disks.
You can only modify the ports of instances that use cloud disks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:ModifyDBInstanceConnectionString	update	Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.	dds-bpxxxxxxxx
NodeId	string	No	The ID of the mongos in the specified sharded cluster instance. Only one mongos ID can be specified in each call. Note This parameter is valid only when you specify the DBInstanceId parameter to the ID of a sharded cluster instance.	s-bpxxxxxxxx
CurrentConnectionString	string	Yes	The current endpoint that is to be modified.	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NewConnectionString	string	Yes	The new endpoint. It must be 8 to 64 characters in length and can contain letters and digits. It must start with a lowercase letter. Note You need only to specify the prefix of the endpoint. The content other than the prefix cannot be modified.	aliyuntest111
NewPort	integer	No	The new port number of the instance. The port number must be within the range from 1000 to 65535. Note This parameter is available only when you set the DBInstanceId parameter to the ID of an instance that uses cloud disks.	3310

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	FF36A84C-0694-42D0-861D-C383E8E4FAAF

Examples

Sample success responses

JSONformat

{
  "RequestId": "FF36A84C-0694-42D0-861D-C383E8E4FAAF"
}

Error codes

HTTP status code	Error code	Error message
400	NewConnectionString.NotSupport	Specified newConnectionString is not supported.
400	MissingParameter	currentConnectionString is mandatory for this action.

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

Change history

Change time	Summary of changes	Operation
2024-07-08	API Description Update. The Error code has changed	View Change Details
2023-10-17	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-10-17	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-03-31	The Error code has changed. The request parameters of the API has changed	View Change Details