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 | Changes the specifications or storage capacity of an ApsaraDB for MongoDB standalone or replica set instance. |
| ModifyNodeSpec | Changes the specifications or storage capacity of an ApsaraDB for MongoDB sharded cluster instance. |
| ModifyNodeSpecBatch | Changes the configurations of one or more mongos or shard nodes of an ApsaraDB for MongoDB sharded cluster instance. |
| CreateNode | Creates a shard or mongos node 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 | Upgrades the minor version of an ApsaraDB for MongoDB instance. |
| ModifyDBInstanceMaintainTime | Modifies the maintenance window of an ApsaraDB for MongoDB instance. |
| ModifyDBInstanceDescription | Changes the description 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 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 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 of each type. |
Resource management
| Operation | 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 ApsaraDB for MongoDB instances that can be created in a specific 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 | Migrates an ApsaraDB for MongoDB instance to a specified destination zone. |
Connection management
| Operation | Description |
|---|---|
| AllocatePublicNetworkAddress | Applies for a public endpoint for 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 a shard or Configserver node of an ApsaraDB for MongoDB sharded cluster instance. |
| AllocateNodePrivateNetworkAddress | Applies for an internal endpoint for the 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 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 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
| Operation | 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
| 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 log 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 sets the log retention period for an ApsaraDB for MongoDB instance. |
| DescribeMongoDBLogConfig | Queries the log feature configurations of an ApsaraDB for MongoDB instance. |
Log management
| Operation | 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. |
Performance monitoring management
| Operation | Description |
|---|---|
| DescribeDBInstancePerformance | Queries the performance data of an ApsaraDB for MongoDB instance. |
| ModifyDBInstanceMonitor | Sets 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. |
Backup and restoration
| Operation | Description |
|---|---|
| DescribeBackupPolicy | Queries the backup policy of an ApsaraDB for MongoDB instance. |
| ModifyBackupPolicy | Modifies the backup policy of a MongoDB instance. |
| CreateBackup | Manually backs up MongoDB instances. |
| DescribeBackups | Queries the backup sets of an ApsaraDB for MongoDB instance. |
| RestoreDBInstance | Restores data to the current ApsaraDB for MongoDB instance. |
| DescribeBackupDBs | Queries the databases at a 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
| 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 instance. |
| DescribeRenewalPrice | Queries the monthly renewal price of an ApsaraDB for MongoDB instance. |