List of API operations by function

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

Lifecycle management

API	Description
CreateDBInstance	Creates and clones replica set instances of ApsaraDB for MongoDB.
ModifyDBInstanceSpec	Modifies the specifications or storage space of an ApsaraDB for MongoDB instance.
DeleteDBInstance	Releases an ApsaraDB for MongoDB instance.
CreateShardingDBInstance	Creates or clones ApsaraDB for MongoDB sharded cluster instances.
CreateNode	Creates shards or mongos for an ApsaraDB for MongoDB sharded cluster instance.
DeleteNode	Deletes a shard or mongos in a sharded cluster instance of ApsaraDB for MongoDB.
ModifyNodeSpec	Modifies the type and storage space of a specified node in an ApsaraDB for MongoDB sharded cluster instance.
DescribeInstanceAutoRenewalAttribute	Queries whether auto-renewal is enabled for an ApsaraDB for MongoDB instance.

Region management

API	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	Changes the zone of an ApsaraDB for MongoDB instance.

Resource Management

API	Description
EvaluateResource	Checks whether sufficient resources are available in the region where you want to create or upgrade an ApsaraDB for MongoDB instance.
DescribeAvailableResource	Queries the types of instances that can be created in specified zones.

Connection management

API	Description
AllocatePublicNetworkAddress	Assigns a public endpoint to an ApsaraDB for MongoDB instance.
ReleasePublicNetworkAddress	Releases the public IP address of an ApsaraDB for MongoDB instance.
ModifyInstanceVpcAuthMode	Enables or disables authentication for an ApsaraDB for MongoDB instance to allow access from the same VPC as the instance.
DescribeShardingNetworkAddress	Queries the connection information of sharded cluster instances of ApsaraDB for MongoDB.
ModifyDBInstanceNetworkType	Changes 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 the shard or Configserver node of a sharded cluster instance.
AllocateNodePrivateNetworkAddress	Applies 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	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 engine versions to which an ApsaraDB for MongoDB instance can be upgraded.
DescribeDBInstances	Queries the list of ApsaraDB for MongoDB instances.
DescribeDBInstanceAttribute	Queries the details of an ApsaraDB for MongoDB instance.
DescribeRoleZoneInfo	Views the roles and zones of nodes in 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 each type of tasks.

Instance management

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

Tag management

API	Description
TagResources	Binds tags to one or more ApsaraDB for MongoDB instances.
ListTagResources	Queries the binding relationship between ApsaraDB for MongoDB instances and tags.
DescribeTags	Queries all tags in a specified region.
UntagResources	Unbinds a tag from an instance. If the tag is not bound to another instance, the tag is deleted.

Account management

API	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.

Whitelists and security groups

API	Description
DescribeSecurityGroupConfiguration	Queries the ECS security groups associated with an ApsaraDB for MongoDB instance.
ModifySecurityGroupConfiguration	Modifies the ECS security group that is bound to the ApsaraDB for MongoDB instance.
DescribeSecurityIps	Queries the IP address whitelist of an ApsaraDB for MongoDB instance.
ModifySecurityIps	Modifies the IP address whitelist of an ApsaraDB for MongoDB instance.

Keys

API	Description
CheckCloudResourceAuthorized	Checks whether 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 details of a key for an ApsaraDB for MongoDB instance.
DescribeDBInstanceTDEInfo	Queries whether TDE is enabled for an ApsaraDB for MongoDB instance.
ModifyDBInstanceTDE	Modifies the transparent data encryption (TDE) status of an ApsaraDB for MongoDB instance.

SSL encryption

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

Audit logs

API	Description
DescribeAuditRecords	Queries the audit log of an ApsaraDB for MongoDB instance.
DescribeAuditFiles	Queries the audit log files of an ApsaraDB for MongoDB instance.
DescribeAuditPolicy	Queries whether the audit log feature is enabled for an ApsaraDB for MongoDB instance.
ModifyAuditLogFilter	Modifies the type of audit log entries that you want to collect for an ApsaraDB for MongoDB instance.
DescribeAuditLogFilter	Queries the types of entries in the audit log collected for an ApsaraDB for MongoDB instance.
ModifyAuditPolicy	Enables or disables the audit log feature or set the log retention period for an ApsaraDB for MongoDB instance.

Log management

API	Description
DescribeSlowLogRecords	Queries entries in the slow query log of an ApsaraDB for MongoDB instance.
DescribeErrorLogRecords	Queries the error log of an ApsaraDB for MongoDB instance.
DescribeRunningLogRecords	Queries the operational log of an ApsaraDB for MongoDB instance.
DescribeMongoDBLogConfig	You can call DescribeMongoDBLogConfig to view the log service configuration of ApsaraDB for MongoDB.

Performance monitoring management

API	Description
DescribeDBInstancePerformance	Queries the performance data of an ApsaraDB for MongoDB instance.
ModifyDBInstanceMonitor	Sets the monitoring granularity for an ApsaraDB for MongoDB instance.
DescribeDBInstanceMonitor	Sets the monitoring granularity for an ApsaraDB for MongoDB instance.

Parameter management

API	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

API	Description
DescribeIndexRecommendation	Queries the index recommendation details of an AsparaDB for MongoDB instance.
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

API	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 MongoDB instances.
DescribeBackups	Queries the backups of an ApsaraDB for MongoDB instance.
RestoreDBInstance	Restores data to the current ApsaraDB for MongoDB instance.
DescribeBackupDBs	Queries the databases at the specified time or the databases in a specified 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

API	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	Changes the billing method of an ApsaraDB for MongoDB instance from pay-as-you-go to subscription.
RenewDBInstance	Manually renews a subscription instance.
DescribeRenewalPrice	Queries the monthly renewal price of an ApsaraDB for MongoDB instance.

Appendixes

API	Description
Error codes	Error codes
Instance specifications	Instance specifications
Instance states	Instance states
Performance metrics	Performance metrics