ModifyDBInstanceConnectionString - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

Operation description

You can modify the endpoint and port for the following instance types:

You can modify the endpoints of instances that use local disks or cloud disks.
For sharded cluster instances, you can modify only the endpoints of Mongos nodes.

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

dds:ModifyDBInstanceConnectionString

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note If this parameter is set to the ID of a sharded cluster instance, the `NodeId` parameter is also required.	dds-bpxxxxxxxx
NodeId	string	No	The ID of a Mongos node in the sharded cluster instance. You can specify only one Mongos node ID per call. Note This parameter is available only when the `DBInstanceId` parameter is set to the ID of a sharded cluster instance.	s-bpxxxxxxxx
CurrentConnectionString	string	Yes	The current endpoint that you want to modify.	s-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NewConnectionString	string	Yes	The new endpoint prefix. The prefix must meet the following requirements: Starts with a lowercase letter. Ends with a lowercase letter or a digit. Contains only lowercase letters, digits, and hyphens (-). Is 8 to 63 characters in length. Note Specify only the prefix of the endpoint. The domain name suffix cannot be changed.	aliyuntest111
NewPort	integer	No	The new port. The value must be an integer from 1000 to 65535. Note This parameter is available only when the `DBInstanceId` parameter is set to the ID of a cloud disk instance.	3310

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	NewConnectionString.NotSupport	Specified newConnectionString is not supported.	newConnectionString format
400	InvalidConnectionStringOrPort.Duplicate	Specified connection string or port already exists.	The specified connection string or port information already exists, please check and resubmit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.