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

Instance creation or cloning

Operation Description
CreateDBInstance Creates or clones an ApsaraDB for MongoDB replica set instance.
CreateShardingDBInstance Creates or clones an ApsaraDB for MongoDB sharded cluster instance.

Instance configuration change

Operation Description
ModifyDBInstanceSpec Modifies the specifications or storage space of an ApsaraDB for MongoDB standalone or replica set instance.
ModifyNodeSpec Modifies the specifications or storage space of a specified node in an ApsaraDB for MongoDB sharded cluster instance.
ModifyNodeSpecBatch Modifies the configurations of one or more mongos or shard nodes of an ApsaraDB for MongoDB sharded cluster instance.
CreateNode Creates one or more shard or mongos nodes for an ApsaraDB for MongoDB sharded cluster instance.
CreateNodeBatch Batch adds mongos or shard nodes for an ApsaraDB for MongoDB sharded cluster instance.
DeleteNode Deletes a shard or mongos node for an ApsaraDB for MongoDB sharded cluster instance.

Instance management

Operation Description
UpgradeDBInstanceEngineVersion Upgrades the database version of an ApsaraDB for MongoDB instance.
UpgradeDBInstanceKernelVersion Updates the minor database version of an ApsaraDB for MongoDB instance.
ModifyDBInstanceMaintainTime Modifies the maintenance window of an ApsaraDB for MongoDB instance.
ModifyDBInstanceDescription Modifies the name of an ApsaraDB for MongoDB instance.
ModifyDBInstanceNetExpireTime Extends the retention period of the classic network of an ApsaraDB for MongoDB instance.
SwitchDBInstanceHA Switches between the primary and secondary nodes in an ApsaraDB for MongoDB instance.
RestartDBInstance Restarts an ApsaraDB for MongoDB instance.
DeleteDBInstance Releases an ApsaraDB for MongoDB instance.
DestroyInstance Destroys an ApsaraDB for MongoDB instance.

Instance information query

Operation Description
DescribeReplicaSetRole Queries the role and connection information of an ApsaraDB for MongoDB instance.
DescribeKernelReleaseNotes Queries the release notes of the minor database versions of an ApsaraDB for MongoDB instance.
DescribeAvailableEngineVersion Queries the database engine versions to which an ApsaraDB for MongoDB instance can be upgraded.
DescribeDBInstances Queries the list of ApsaraDB for MongoDB instances.
DescribeDedicatedClusterInstanceList Queries instances in dedicated clusters.
DescribeDBInstanceAttribute Queries the detailed information of ApsaraDB for MongoDB instances.
DescribeRoleZoneInfo Views the roles and zones of nodes in an ApsaraDB for MongoDB instance.
DescribeInstanceAutoRenewalAttribute Queries whether auto-renewal is enabled for an ApsaraDB for MongoDB instance.
DescribeActiveOperationTaskCount Queries the number of O&M tasks on an ApsaraDB for MongoDB instance.
DescribeActiveOperationTaskType Queries the types of O&M tasks on an ApsaraDB for MongoDB instance and the number of tasks for each type.

Resource management

Operation Description
EvaluateResource Checks whether available resources are sufficient within the region where you want to create or upgrade an ApsaraDB for MongoDB instance.
DescribeAvailableResource Queries the types of ApsaraDB for MongoDB instances that can be created in a specified zone.
ModifyResourceGroup Migrates an AsparaDB for MongoDB instance to a specified resource group.

Region management

Operation Description
MigrateToOtherZone Migrates an ApsaraDB for MongoDB instance to another zone.
DescribeRegions Views the regions and zones that an ApsaraDB for MongoDB instance can be created.
MigrateAvailableZone Modifies the zone of an ApsaraDB for MongoDB instance.

Connection management

Operation Description
AllocatePublicNetworkAddress Applies for a public endpoint for an ApsaraDB for MongoDB instance.
ReleasePublicNetworkAddress Releases the public endpoint of an ApsaraDB for MongoDB instance.
ModifyInstanceVpcAuthMode Enables or disables password-free access to an ApsaraDB for MongoDB instance from the VPC to which the instance belongs.
DescribeShardingNetworkAddress Queries the connection information of one or more ApsaraDB for MongoDB sharded cluster instances.
ModifyDBInstanceNetworkType Modifies the network type of an ApsaraDB for MongoDB instance.
ModifyDBInstanceConnectionString Modifies the connection string of an ApsaraDB for MongoDB instance.
ReleaseNodePrivateNetworkAddress Releases the internal endpoint of a shard or Configserver node of an ApsaraDB for MongoDB sharded cluster instance.
AllocateNodePrivateNetworkAddress Applies for an internal endpoint for a shard or Configserver node of an ApsaraDB for MongoDB sharded cluster instance.

Tag management

Operation Description
TagResources Adds tags to one or more ApsaraDB for MongoDB instances.
ListTagResources Queries the relationship between ApsaraDB for MongoDB instances and tags.
DescribeTags Queries all tags in a specified region.
UntagResources Removes a tag from an ApsaraDB for MongoDB instance. If the tag is not added to another instance, the tag is deleted.

Account management

Operation Description
DescribeAccounts Queries the database accounts of an ApsaraDB for MongoDB instance.
ResetAccountPassword Resets the password of the root account of an ApsaraDB for MongoDB instance.
ModifyAccountDescription Modifies the description of the root account of an ApsaraDB for MongoDB instance.

IP address whitelists and security groups

Operation Description
DescribeSecurityGroupConfiguration Queries the Elastic Compute Service (ECS) security groups associated with an ApsaraDB for MongoDB instance.
ModifySecurityGroupConfiguration Modifies one or more ECS security groups that are associated with an ApsaraDB for MongoDB instance.
DescribeSecurityIps Queries one or more IP address whitelists of an ApsaraDB for MongoDB instance.
ModifySecurityIps Modifies one or more IP address whitelists of an ApsaraDB for MongoDB instance.

Keys

Operation Description
CheckCloudResourceAuthorized Checks whether Key Management Service (KMS) keys are authorized to ApsaraDB for MongoDB instances.
DescribeUserEncryptionKeyList Queries the list of custom keys for an ApsaraDB for MongoDB instance.
DescribeDBInstanceEncryptionKey Queries the detailed information of a key for an ApsaraDB for MongoDB instance.
DescribeDBInstanceTDEInfo Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.
ModifyDBInstanceTDE Modifies the TDE status of an ApsaraDB for MongoDB instance.

SSL encryption

Operation Description
ModifyDBInstanceSSL Modifies the SSL settings of an ApsaraDB for MongoDB instance.
DescribeDBInstanceSSL Queries the SSL settings of an ApsaraDB for MongoDB instance.

Audit logs

Operation Description
DescribeAuditRecords Queries the audit logs of an ApsaraDB for MongoDB instance.
DescribeAuditPolicy Queries whether the audit log feature is enabled for an ApsaraDB for MongoDB instance.
ModifyAuditLogFilter Modifies the types of audit log entries that you want to collect for an ApsaraDB for MongoDB instance.
DescribeAuditLogFilter Queries the types of audit log entries collected for an ApsaraDB for MongoDB instance.
ModifyAuditPolicy Enables or disables the audit log feature or sets the log retention period for an ApsaraDB for MongoDB instance.

Log management

Operation Description
DescribeSlowLogRecords Queries entries in the slow query logs of an ApsaraDB for MongoDB instance.
DescribeErrorLogRecords Queries the error logs of an ApsaraDB for MongoDB instance.
DescribeRunningLogRecords Queries the operational logs of an ApsaraDB for MongoDB instance.
DescribeMongoDBLogConfig Queries the log feature configurations of an ApsaraDB for MongoDB instance.

Performance monitoring management

Operation Description
DescribeDBInstancePerformance Queries the performance data of an ApsaraDB for MongoDB instance.
ModifyDBInstanceMonitor Modifies the collection frequency of monitoring data for an ApsaraDB for MongoDB instance.
DescribeDBInstanceMonitor Queries the collection frequency of monitoring data for an ApsaraDB for MongoDB instance.

Parameter management

Operation Description
DescribeParameterModificationHistory Queries the modification records of ApsaraDB for MongoDB instance parameters.
DescribeParameters Queries parameter configurations of an ApsaraDB for MongoDB instance.
DescribeParameterTemplates Queries the list of default parameter templates for ApsaraDB for MongoDB instances.
ModifyParameters Modifies the parameters of an AsparaDB for MongoDB instance.

Index recommendation

Operation Description
CreateRecommendationTask Creates index analysis tasks for an AsparaDB for MongoDB instance.
DescribeAvailableTimeRange Queries the analysis period and generation status of the index analysis report on an ApsaraDB for MongoDB instance.

Backup and restoration

Operation Description
DescribeBackupPolicy Queries the backup policy of an ApsaraDB for MongoDB instance.
ModifyBackupPolicy Modifies the backup policy of an ApsaraDB for MongoDB instance.
CreateBackup Manually backs up ApsaraDB for MongoDB instances.
DescribeBackups Queries the backups of an ApsaraDB for MongoDB instance.
RestoreDBInstance Restores data to the current ApsaraDB for MongoDB instance.
DescribeBackupDBs Queries database backups of a specified point in time or backup set before you restore a database for an ApsaraDB for MongoDB instance.
CheckRecoveryCondition Checks whether an ApsaraDB for MongoDB instance meets the data restoration conditions.

Renewal management

Operation Description
DescribePrice Queries the fees incurred by creating, upgrading, or renewing ApsaraDB for MongoDB instances.
ModifyInstanceAutoRenewalAttribute Enables or disables auto-renewal for an ApsaraDB for MongoDB instance.
TransformToPrePaid Modifies the billing method of an ApsaraDB for MongoDB instance from pay-as-you-go to subscription.
RenewDBInstance Manually renews a subscription ApsaraDB for MongoDB instance.
DescribeRenewalPrice Queries the monthly renewal price of an ApsaraDB for MongoDB instance.

Appendixes