Create a Read-Only Account for MongoDB Shard Nodes via API - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Operation description

Shard accounts can be created only for ApsaraDB for MongoDB sharded cluster instances with cloud disks.
Shard accounts are granted fixed read-only permissions.

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:CreateAccount

create

*DBInstance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-uf6e9433e955xxxx
AccountName	string	Yes	The account name. The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (_). It must start with a lowercase letter. The account has read-only permissions.	admin1
AccountPassword	string	Yes	The account password. The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include ! @ # $ % ^ & * ( ) _ + - = Note For information about how to handle special characters, see What do I do if a connection fails because the username or password in the connection string contains special characters?	Test123456!
CharacterType	string	No	The type of the account to be created. Valid values: db: shard account. This is the default value. cs: Configserver account. normal: replica set account. Note Currently, only db accounts are supported.	db

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	7FEF1BEF-2842-5758-9126-415A297XXXXX
TaskId	integer	The task ID.	123456

Examples

Success response

JSON format

{
  "RequestId": "7FEF1BEF-2842-5758-9126-415A297XXXXX",
  "TaskId": 123456
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidAccountName.Malformed	Specified parameter AccountName is not valid.	The specified AccountName parameter is invalid.
400	InvalidAccountPassword.Malformed	Specified parameter AccountPassword is not valid.	The specified parameter AccountPassword is invalid.
400	InvalidAccountDescription.Malformed	Specified parameter AccountDescription is not valid.	The specified AccountDescription parameter is invalid.
404	AccountLimitExceeded	AccountQuotaExceeded: Exceeding the allowed amount of account.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.