edit-icon download-icon

DescribeAccounts

Last Updated: Dec 08, 2017

Description

This API supports both replica set instances and sharded cluster instances.

Input parameters

NameTypeRequired or notDescription
ActionStringYesRequired parameter; value: DescribeAccounts.
DBInstanceIdStringYesInstance ID
AccountNameStringYesAccount name

Response parameters

NameTypeDescription
AccountsList<Account>Array composed of accounts

Account data structure

NameTypeDescription
DBInstanceIdStringName of the instance to which the account belongs
AccountNameStringAccount name
AccountStatusString Account status:
- Unavailable: The account cannot be used.
- Available: The account can be used.
AccountDescriptionStringAccount remarks
Thank you! We've received your feedback.