All Products
Document Center

ApsaraDB for MongoDB:ModifyDBInstanceConnectionString

Last Updated:Jan 17, 2023

You can call this operation to modify the connection string of a MongoDB instance.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
dds:ModifyDBInstanceConnectionString WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
DBInstanceId string Yes

The ID of the instance.

Note If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.
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 if you set the DBInstanceId parameter to the ID of a sharded cluster instance.
CurrentConnectionString string Yes

The current connection string, which is to be modified.
NewConnectionString string Yes

The new connection string. 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 connection string. The content other than the prefix cannot be modified.

Response parameters

Parameter Type Description Example
RequestId string

The ID of the request.



Normal return example


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

Error codes

Http 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 API error center.