The following tables list API operations available for use in ApsaraDB for MongoDB.

Lifecycle management

API Description
CreateDBInstance You can call this operation to create and clone ApsaraDB for MongoDB instances.
ModifyDBInstanceSpec You can call this operation to change the specification or storage space of a standalone or replica set instance.
DeleteDBInstance You can call this operation to release a MongoDB instance.
CreateShardingDBInstance You can call this operation to create or clone ApsaraDB for MongoDB sharded cluster instances.
CreateNode You can call this operation to create shards or mongos for ApsaraDB for MongoDB sharded cluster instances.
DeleteNode You can call this operation to delete a shard or mongos in a sharded cluster instance of ApsaraDB for MongoDB.
ModifyNodeSpec You can call this operation to modify the type and storage space of the nodes in ApsaraDB for MongoDB sharded cluster instances.
DescribeInstanceAutoRenewalAttribute You can call this operation to query whether auto-renewal is enabled for an ApsaraDB for MongoDB instance.

Region management

API Description
MigrateToOtherZone You can call this operation to migrate MigrateToOtherZone MongoDB instance to another zone.
DescribeRegions You can call this operation to view the available regions and zones of a MongoDB instance.
MigrateAvailableZone You can call this operation to change the zone of a MongoDB instance.

Resource Management

API Description
EvaluateResource Before purchasing a new instance or changing the configuration of an instance, call EvaluateResource to check whether the instance has sufficient resources.
DescribeAvailableResource Queries the types of instances that can be created in specified zones.

Connection management

API Description
AllocatePublicNetworkAddress You can call this operation to assign a public IP address to a MongoDB instance.
ReleasePublicNetworkAddress You can call this operation to release the public IP address of a MongoDB instance.
ModifyInstanceVpcAuthMode You can call this operation to enable or disable authentication for a MongoDB instance to allow access from the same VPC as the instance.
DescribeShardingNetworkAddress You can call this operation to query the connection information of sharded cluster instances in ApsaraDB for MongoDB.
ModifyDBInstanceNetworkType You can call this operation to change the network type of a MongoDB instance.
ModifyDBInstanceConnectionString You can call this operation to modify the connection address of a MongoDB instance.
ReleaseNodePrivateNetworkAddress You can call this operation to release the internal endpoint of the shard or Configserver node of a sharded cluster instance.
AllocateNodePrivateNetworkAddress You can call this operation to apply for an internal endpoint for the shard or Configserver node of an ApsaraDB for MongoDB sharded cluster instance.

Queries the information of an instance

API Description
DescribeReplicaSetRole You can call this operation to query the role and connection information of a MongoDB instance.
DescribeKernelReleaseNotes You can call this operation to query the release notes of the minor database versions of a MongoDB instance.
DescribeAvailableEngineVersion You can call this operation to query the engine versions that an ApsaraDB for MongoDB instance can be upgraded to.
DescribeDBInstances You can call this operation to query the list of MongoDB instances.
DescribeDBInstanceAttribute You can call this operation to query the details of a MongoDB instance.
DescribeRoleZoneInfo You can call this operation to query the roles and zones of the nodes in an apsaradb for MongoDB instance.
DescribeActiveOperationTaskCount You can call this operation to query the number of O&M tasks of an apsaradb for MongoDB instance.
DescribeActiveOperationTaskType You can call this operation to query the types of O&M tasks of apsaradb for MongoDB instances and the number of each type of tasks.

Instance management

API Description
RestartDBInstance You can call this operation to restart a MongoDB instance.
ModifyDBInstanceMaintainTime You can call this operation to modify the O&M period of a MongoDB instance.
ModifyDBInstanceDescription You can call this operation to change the name of a MongoDB instance.
SwitchDBInstanceHA You can call this operation to switch between the primary and secondary nodes in a MongoDB instance.
UpgradeDBInstanceEngineVersion You can call this operation to upgrade the database version of a MongoDB instance.
DestroyInstance You can call this operation to release a MongoDB instance.
UpgradeDBInstanceKernelVersion You can call this operation to upgrade the minor database version of a MongoDB instance.
ModifyDBInstanceNetExpireTime You can call this operation to extend the retention period of the classic network of a MongoDB instance.

Tag management

API Description
TagResources You can call this operation to bind tags to one or more ApsaraDB for MongoDB instances.
ListTagResources You can call this operation to query the binding relationship between ApsaraDB for MongoDB instances and tags.
DescribeTags You can call this operation to query all tags in a specified region.
UntagResources You can call this operation to unbind a tag from an instance. If the tag is not bound to another instance, it is deleted.

Account management

API Description
DescribeAccounts You can call this operation to query the information of the database account of a MongoDB instance.
ResetAccountPassword You can call this operation to reset the password of the root account of a MongoDB instance.
ModifyAccountDescription You can call this operation to modify the description of the root account of a MongoDB instance.

Whitelist and security groups

API Description
DescribeSecurityGroupConfiguration You can call this operation to query the ECS Security groups associated with an apsaradb for MongoDB instance.
ModifySecurityGroupConfiguration You can call this operation to modify the ECS Security group that is bound to the apsaradb for MongoDB instance.
DescribeSecurityIps You can call this operation to query the IP address whitelist of a MongoDB instance.
ModifySecurityIps You can call this operation to modify the IP address whitelist of the MongoDB instance.

Encryption keys

API Description
CheckCloudResourceAuthorized You can call this operation to check whether KMS keys are authorized to ApsaraDB for MongoDB instances.
DescribeUserEncryptionKeyList Call DescribeUserEncryptionKeyList to query the custom keys of instances.
DescribeDBInstanceEncryptionKey You can call this operation to query the details of a key for an ApsaraDB for MongoDB instance.
DescribeDBInstanceTDEInfo You can call this operation to query whether TDE is enabled for a MongoDB instance.
ModifyDBInstanceTDE You can call this operation to modify the TDE status of an MongoDB instance.

SSL encryption

API Description
ModifyDBInstanceSSL You can call this operation to modify the SSL configuration of a MongoDB instance.
DescribeDBInstanceSSL You can call this operation to query the SSL settings of a MongoDB instance.

Audit logs

API Description
DescribeAuditRecords You can call this operation to query the records of audit logs of MongoDB instances.
DescribeAuditFiles You can call this operation to query the audit log files of MongoDB instances.
DescribeAuditPolicy You can call this operation to query whether the log audit function is enabled for a MongoDB instance.
ModifyAuditLogFilter You can call this operation to modify the type of audit logs to be collected for MongoDB instances.
DescribeAuditLogFilter You can call this operation to query the types of audit logs collected from MongoDB instances.
ModifyAuditPolicy You can call this operation to enable or disable the audit log feature or set the log storage period for an ApsaraDB for MongoDB instance.

Log management

API Description
DescribeSlowLogRecords You can call this operation to query the slow operation log details of the MongoDB instance.
DescribeErrorLogRecords You can call this operation to query the error logs of the MongoDB instance.
DescribeRunningLogRecords You can call this operation to query the running logs of the MongoDB instance.
DescribeMongoDBLogConfig You can call DescribeMongoDBLogConfig to view the log service configuration of apsaradb for MongoDB.

Performance monitoring management

API Description
DescribeDBInstancePerformance You can call this operation to query the performance data of a MongoDB instance.
ModifyDBInstanceMonitor You can call this operation to set the monitoring granularity for a ApsaraDB for MongoDB instance.
DescribeDBInstanceMonitor You can call this operation to query the monitoring granularity of an apsaradb for MongoDB instance.

Parameter management

API Description
DescribeParameterModificationHistory You can call this operation to query the modification records of MongoDB instance parameters.
DescribeParameters You can call this operation to query information about the parameter configuration of ApsaraDB for MongoDB instances.
DescribeParameterTemplates You can call this operation to query the list of default parameter templates for ApsaraDB for MongoDB instances.
ModifyParameters You can call this operation to modify the parameters of an AsparaDB for MongoDB instance.

Index recommendation

API Description
DescribeIndexRecommendation You can call this operation to query the index recommendation details of an AsparaDB for MongoDB instance.
CreateRecommendationTask You can call this operation to create index analysis tasks for an AsparaDB for MongoDB instance.
DescribeAvailableTimeRange You can call this operation to query the analysis period and generation status of the index analysis report on an ApsaraDB for MongoDB instance.

Backup and Recovery

API Description
DescribeBackupPolicy You can call this operation to query the backup policy of a MongoDB instance.
ModifyBackupPolicy You can call this operation to modify the backup policy of a MongoDB instance.
CreateBackup You can call this operation to manually back up MongoDB instances.
DescribeBackups You can call this operation to query the backups of a MongoDB instance.
RestoreDBInstance You can call this operation to restore data to the current MongoDB instance.
DescribeBackupDBs Before you restore a single database to an apsaradb for MongoDB instance, you can call this operation to query the databases at a specified point in time or contained in a backup set.
CheckRecoveryCondition You can call this operation to check whether an ApsaraDB for MongoDB instance meets the data recovery conditions.

Renewal management

API Description
DescribePrice You can call this operation to query the prices of creating, upgrading, and renewing apsaradb for MongoDB instances.
ModifyInstanceAutoRenewalAttribute You can call this operation to enable or disable auto-renewal for an ApsaraDB for MongoDB instance.
TransformToPrePaid You can call this operation to convert a pay-as-you-go apsaradb for MongoDB instance to a subscription instance.
RenewDBInstance You can call this operation to manually renew the subscription RenewDBInstance of an apsaradb for MongoDB instance.
DescribeRenewalPrice You can call this operation to query the monthly renewal price of an ApsaraDB for MongoDB instance.

Appendix

API Description
Error codes Error codes
Instance types Instance types
Instance statuses Instance states
Performance metrics Performance metrics