Modifies the endpoint that is used to connect to an ApsaraDB for MongoDB instance.
Debugging
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 Resourcesis 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 | WRITE |
|
| 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 |
Response parameters
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-10-17 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
| ||||||||||
| 2023-10-17 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
| ||||||||||
| 2023-03-31 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||
|