API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Dds/2015-12-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Create or clone an instance
|
API |
Title |
Description |
| CreateDBInstance | CreateDBInstance | Creates or clones an ApsaraDB for MongoDB replica set instance. |
| CreateShardingDBInstance | CreateShardingDBInstance | Creates or clones a MongoDB sharded cluster instance. |
Modify instance configuration
|
API |
Title |
Description |
| CreateNode | CreateNode | Adds a shard or mongos node to an ApsaraDB for MongoDB instance. |
| CreateNodeBatch | CreateNodeBatch | Batch adds mongos or shard nodes for a sharded cluster instance. |
| DeleteNode | DeleteNode | Deletes a shard or mongos node from an ApsaraDB for MongoDB sharded cluster instance. |
| ModifyDBInstanceSpec | ModifyDBInstanceSpec | Changes the instance type or storage capacity of an ApsaraDB for MongoDB standalone instance, replica set instance, or Serverless instance. Serverless instances are available only on the Alibaba Cloud China Website (www.aliyun.com). |
| ModifyNodeSpec | ModifyNodeSpec | Changes the instance type and storage space of a node in a MongoDB sharded cluster instance. |
| ModifyNodeSpecBatch | ModifyNodeSpecBatch | Changes the configuration of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance. |
| ModifyDBInstanceDiskType | ModifyDBInstanceDiskType | Modifies the disk type of an ApsaraDB for MongoDB instance. |
Instance Management
|
API |
Title |
Description |
| DeleteDBInstance | DeleteDBInstance | Releases a pay-as-you-go MongoDB instance. |
| ModifyDBInstanceMaintainTime | ModifyDBInstanceMaintainTime | Modifies the maintenance window of an ApsaraDB for MongoDB instance. |
| ModifyDBInstanceDescription | ModifyDBInstanceDescription | Modifies the name of an ApsaraDB for MongoDB instance. |
| ModifyDBInstanceNetExpireTime | ModifyDBInstanceNetExpireTime | Extends the retention period of the classic network endpoint of an ApsaraDB for MongoDB instance. |
| UpgradeDBInstanceEngineVersion | UpgradeDBInstanceEngineVersion | Upgrades the database version of an ApsaraDB for MongoDB instance. |
| UpgradeDBInstanceKernelVersion | UpgradeDBInstanceKernelVersion | Upgrades the minor version of an ApsaraDB for MongoDB instance. |
| SwitchDBInstanceHA | SwitchDBInstanceHA | Switches the primary and secondary nodes for an ApsaraDB for MongoDB instance. |
| RestartDBInstance | RestartDBInstance | Restarts an ApsaraDB for MongoDB instance. |
| DestroyInstance | DestroyInstance | Destroys an ApsaraDB for MongoDB instance. |
| RestartNode | RestartNode | Restarts a single node of a MongoDB instance. |
Renewal management
|
API |
Title |
Description |
| ModifyInstanceAutoRenewalAttribute | ModifyInstanceAutoRenewalAttribute | Enables or disables auto-renewal for an ApsaraDB for MongoDB instance. |
| TransformInstanceChargeType | TransformInstanceChargeType | Changes the billing method of an instance from pay-as-you-go to subscription or from subscription to pay-as-you-go. |
| DescribePrice | DescribePrice | Queries the price of an instance. |
| DescribeRenewalPrice | DescribeRenewalPrice | Queries the monthly renewal price of an ApsaraDB for MongoDB instance. |
| TransformToPrePaid | TransformToPrePaid | Changes the billing method of an ApsaraDB for MongoDB instance from pay-as-you-go to subscription. |
| RenewDBInstance | RenewDBInstance | Manually renews an ApsaraDB for MongoDB subscription instance. |
Query instances
|
API |
Title |
Description |
| DescribeDBInstanceSpecInfo | DescribeDBInstanceSpecInfo | Gets instance type details. |
| DescribeReplicaSetRole | DescribeReplicaSetRole | Queries the role and connection information for a MongoDB instance. |
| DescribeKernelReleaseNotes | DescribeKernelReleaseNotes | Queries the release notes of the minor versions of an ApsaraDB for MongoDB instance. |
| DescribeAvailableEngineVersion | DescribeAvailableEngineVersion | Queries the engine versions to which an ApsaraDB for MongoDB instance can be upgraded. |
| DescribeDBInstances | DescribeDBInstances | Queries a list of MongoDB instances. |
| DescribeDBInstanceSwitchLog | DescribeDBInstanceSwitchLog | Queries the primary/secondary switching logs of an ApsaraDB for MongoDB instance. |
| DescribeDBInstanceAttribute | DescribeDBInstanceAttribute | Queries the details of an ApsaraDB for MongoDB instance. |
| DescribeRoleZoneInfo | DescribeRoleZoneInfo | Queries the role and zone of each node in an ApsaraDB for MongoDB instance. |
| DescribeInstanceAutoRenewalAttribute | DescribeInstanceAutoRenewalAttribute | You can call this operation to query whether auto-renewal is enabled for an ApsaraDB for MongoDB instance. |
| DescribeActiveOperationTaskCount | DescribeActiveOperationTaskCount | Queries the number of operation and maintenance tasks on an ApsaraDB for MongoDB instance. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries the details of scheduled operations and maintenance (O&M) tasks for a MongoDB instance. |
| DescribeActiveOperationTaskType | DescribeActiveOperationTaskType | Queries the types of Operation and Maintenance tasks and the number of tasks of each type for an ApsaraDB for MongoDB instance. |
| DescribeDBInstancesOverview | DescribeDBInstancesOverview | Queries the overview of one or more ApsaraDB for MongoDB instances. |
| DescribeHistoryTasks | DescribeHistoryTasks | Queries a list of tasks in the task center. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | Queries the overview of a task in the task center. |
| ModifyTaskInfo | ModifyTaskInfo | Modifies the information of a task in the task center for an ApsaraDB for MongoDB instance. |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Modifies the switching time of scheduled O\\\\\\&M tasks for an ApsaraDB for MongoDB instance. |
Resource Management
|
API |
Title |
Description |
| DescribeAvailableResource | DescribeAvailableResource | Queries the available resources in the specified zone. |
| EvaluateResource | EvaluateResource | Evaluates whether sufficient resources are available before you purchase a new instance or upgrade or downgrade an existing instance. |
| DescribeAvailabilityZones | DescribeAvailabilityZones | Queries a list of the zones that are supported by an ApsaraDB for MongoDB instance. |
| ModifyResourceGroup | ModifyResourceGroup | Moves an ApsaraDB for MongoDB instance to a specified resource group. |
Region management
|
API |
Title |
Description |
| DescribeRegions | DescribeRegions | Queries all regions and zones supported for an ApsaraDB for MongoDB instance. |
| MigrateToOtherZone | MigrateToOtherZone | You can call this operation to migrate an ApsaraDB for MongoDB instance to another zone. |
| MigrateAvailableZone | MigrateAvailableZone | Migrates an ApsaraDB for MongoDB instance to a specific zone. |
Connection management
|
API |
Title |
Description |
| ModifyInstanceVpcAuthMode | ModifyInstanceVpcAuthMode | Disables password-free access over Virtual Private Cloud (VPC) for an ApsaraDB for MongoDB instance. |
| ModifyDBInstanceNetworkType | ModifyDBInstanceNetworkType | Changes the network type of an ApsaraDB for MongoDB instance. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | Modifies the connection address and port of a MongoDB instance. |
| DescribeShardingNetworkAddress | DescribeShardingNetworkAddress | Queries the connection information for a MongoDB sharded cluster instance. |
| AllocatePublicNetworkAddress | AllocatePublicNetworkAddress | Allocates a public endpoint to an instance. |
| ReleasePublicNetworkAddress | ReleasePublicNetworkAddress | Releases the public endpoint of an ApsaraDB for MongoDB instance. |
| AllocateNodePrivateNetworkAddress | AllocateNodePrivateNetworkAddress | Applies for an internal endpoint for a shard or Configserver node in an ApsaraDB for MongoDB sharded cluster instance. |
| ReleaseNodePrivateNetworkAddress | ReleaseNodePrivateNetworkAddress | Releases the internal endpoint of a shard or Configserver node for a sharded cluster instance. |
Tag management
|
API |
Title |
Description |
| ListTagResources | ListTagResources | Queries the relationship between ApsaraDB for MongoDB instances and tags. |
| DescribeTags | DescribeTags | Queries all tags in a specified region. |
| TagResources | TagResources | Binds tags to ApsaraDB for MongoDB instances. |
| UntagResources | UntagResources | Removes a tag if the tag is not added to another instance. |
Account Management
|
API |
Title |
Description |
| CreateAccount | CreateAccount | Creates an account that is granted read-only permissions for shard nodes in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks. |
| ResetAccountPassword | ResetAccountPassword | Resets the password of the root account in an ApsaraDB for MongoDB instance. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of the root account in an ApsaraDB for MongoDB instance. |
| DescribeAccounts | DescribeAccounts | Queries the database accounts of an ApsaraDB for MongoDB instance. |
Whitelists and security groups
|
API |
Title |
Description |
| ModifySecurityIps | ModifySecurityIps | Modifies the IP address whitelist of an ApsaraDB for MongoDB instance. |
| ModifySecurityGroupConfiguration | ModifySecurityGroupConfiguration | You can call this operation to modify an ECS Security group that is bound to an ApsaraDB for MongoDB instance. |
| DescribeSecurityIps | DescribeSecurityIps | You can call this operation to query the IP whitelists of an ApsaraDB for MongoDB instance. |
| DescribeSecurityGroupConfiguration | DescribeSecurityGroupConfiguration | Queries the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB for MongoDB instance. |
| ModifyGlobalSecurityIPGroup | ModifyGlobalSecurityIPGroup | Modifies the global IP whitelist template associated with an ApsaraDB for MongoDB instance. |
| DescribeGlobalSecurityIPGroup | DescribeGlobalSecurityIPGroup | Queries the global IP whitelist template of an ApsaraDB for MongoDB instance. |
| ModifyGlobalSecurityIPGroupName | ModifyGlobalSecurityIPGroupName | Modifies the name of a global IP whitelist template associated with an ApsaraDB for MongoDB instance. |
| DescribeGlobalSecurityIPGroupRelation | DescribeGlobalSecurityIPGroupRelation | Queries the mapping between an instance and a global IP address whitelist template. |
| CreateGlobalSecurityIPGroup | CreateGlobalSecurityIPGroup | Creates a global IP whitelist template. |
| ModifyGlobalSecurityIPGroupRelation | ModifyGlobalSecurityIPGroupRelation | Modifies the mapping between a global whitelist template and an ApsaraDB for MongoDB instance. |
| DeleteGlobalSecurityIPGroup | DeleteGlobalSecurityIPGroup | Deletes a global IP address whitelist template. |
Keys
|
API |
Title |
Description |
| ModifyDBInstanceTDE | ModifyDBInstanceTDE | Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance. |
| CheckCloudResourceAuthorized | CheckCloudResourceAuthorized | Checks whether Key Management Service (KMS) keys are authorized to an ApsaraDB for MongoDB instance. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | Queries the custom keys for an instance. |
| DescribeDBInstanceEncryptionKey | DescribeDBInstanceEncryptionKey | Queries the details of a key for an ApsaraDB for MongoDB instance. |
| DescribeDBInstanceTDEInfo | DescribeDBInstanceTDEInfo | Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance. |
| DescribeKmsKeys | DescribeKmsKeys | Queries Key Management Service (KMS) keys that are available for disk encryption. |
SSL encryption
|
API |
Title |
Description |
| ModifyDBInstanceSSL | ModifyDBInstanceSSL | Modifies the SSL configuration of a MongoDB instance. |
| DescribeDBInstanceSSL | DescribeDBInstanceSSL | Queries the details of the SSL configuration for a MongoDB instance. |
Audit logs
|
API |
Title |
Description |
| ModifyAuditLogFilter | ModifyAuditLogFilter | Queries the types of logs collected by the audit log feature of an ApsaraDB for MongoDB instance. |
| ModifyAuditPolicy | ModifyAuditPolicy | Configures the audit log switch or the storage duration of logs for a MongoDB instance. |
| DescribeAuditRecords | DescribeAuditRecords | Queries the audit logs of a MongoDB instance. |
| DescribeAuditPolicy | DescribeAuditPolicy | Queries whether the audit log feature is enabled for a MongoDB instance. |
| DescribeAuditLogFilter | DescribeAuditLogFilter | Queries the types of entries in the audit log collected for an ApsaraDB for MongoDB instance. |
| DescribeMongoDBLogConfig | DescribeMongoDBLogConfig | You can view the configuration of MongoDB Log Service. |
Log Management
|
API |
Title |
Description |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the details of entries in slow query logs of an ApsaraDB for MongoDB instance. |
| DescribeErrorLogRecords | DescribeErrorLogRecords | Queries entries in error logs of an ApsaraDB for MongoDB instance. |
| DescribeRunningLogRecords | DescribeRunningLogRecords | Queries the operational logs of an ApsaraDB for MongoDB instance. |
Performance monitoring
|
API |
Title |
Description |
| ModifyDBInstanceMonitor | ModifyDBInstanceMonitor | You can call this operation to set the monitoring granularity for an ApsaraDB for MongoDB instance. |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance | Queries the performance data of a MongoDB instance. |
| DescribeDBInstanceMonitor | DescribeDBInstanceMonitor | Queries the collection frequency of monitoring data for an ApsaraDB for MongoDB instance. |
Parameter Management
|
API |
Title |
Description |
| ModifyParameters | ModifyParameters | Modifies the parameters of an ApsaraDB for MongoDB instance. |
| DescribeParameterModificationHistory | DescribeParameterModificationHistory | Queries the parameter modification records of an ApsaraDB for MongoDB instance. |
| DescribeParameterTemplates | DescribeParameterTemplates | Queries the default parameter templates for MongoDB instances. |
| DescribeParameters | DescribeParameters | Queries the parameter settings of an ApsaraDB for MongoDB instance. |
Backup and recovery
|
API |
Title |
Description |
| CreateBackup | CreateBackup | Creates a backup for a MongoDB instance. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the backup policy of a MongoDB instance. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup policy of a MongoDB instance. |
| DescribeBackups | DescribeBackups | Queries the backups of a MongoDB instance. |
| DescribeBackupDBs | 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. |
| DescribeRestoreDBInstanceList | DescribeRestoreDBInstanceList | Queries ApsaraDB for MongoDB instances whose backups are restored within seven days. |
| CheckRecoveryCondition | CheckRecoveryCondition | Queries whether the data of an ApsaraDB for MongoDB instance can be restored. |
| TransferClusterBackup | TransferClusterBackup | Switches the backup mode of an ApsaraDB for MongoDB sharded cluster instance to the cluster backup mode. After the instance is switched to the cluster backup mode, the instance supports high-frequency backup. |
| DescribeClusterBackups | DescribeClusterBackups | Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks. |
| DescribeClusterRecoverTime | DescribeClusterRecoverTime | Queries the recoverable time range of an ApsaraDB for MongoDB sharded cluster instance with disk storage. |
| DescribeBackupStorage | DescribeBackupStorage | Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks. |
| DescribeBackupTasks | DescribeBackupTasks | Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks. |
| DescribeInstanceRecoverTime | DescribeInstanceRecoverTime | Queries the recoverable time range for an ApsaraDB for MongoDB replica set instance with disk storage. |
Additional Information
|
API |
Title |
Description |
| DescribeActiveOperationTask | DescribeActiveOperationTask | Queries the detailed information about tasks of an ApsaraDB for MongoDB instance. |
| AllocateDBInstanceSrvNetworkAddress | AllocateDBInstanceSrvNetworkAddress | Applies for an SRV connection string for an ApsaraDB for MongoDB instance. |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels Operations and Maintenance (O&M) events in a batch. |
| DescribeActiveOperationTaskRegion | Query maintenance task types and task quantities. | Queries the types and number of O&M tasks for a MongoDB instance. |
| DescribeActiveOperationMaintenanceConfig | DescribeActiveOperationMaintenanceConfig | Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance. |
| CheckServiceLinkedRole | CheckServiceLinkedRole | Checks whether a service-linked role (SLR) is created for an instance. |
| ModifyDBInstanceConfig | ModifyDBInstanceConfig | Modifies instance configuration |
| CreateNodeRoleTag | CreateNodeRoleTag | Creates a role tag for an instance node. |
| ModifyDBInstanceAttribute | ModifyDBInstanceAttribute | Modifies instance release protection configuration. |
| ModifySrvNetworkAddress | ModifySrvNetworkAddress | Modifies the SRV connection address of a MongoDB instance. |
| DescribeRdsVSwitchs | DescribeRdsVSwitchs | Queries a list of vSwitches. |
| DescribeRdsVpcs | DescribeRdsVpcs | Queries a list of VPCs. |
| DescribeRoleTagStatus | DescribeRoleTagStatus | Describes the status of a tag for a node. |
| DescribeVpcsForMongoDB | DescribeVpcsForMongoDB | Queries a paginated list of VPCs. |
Others
|
API |
Title |
Description |
| DeleteBackup | DeleteBackup | Deletes a MongoDB backup set. |
| DescribeBinlogFiles | DescribeBinlogFiles | Queries binary log files bound to an ApsaraDB for MongoDB instance. |
| ModifyActiveOperationMaintenanceConfig | ModifyActiveOperationMaintenanceConfig | Modifies the Operations and Maintenance (O&M) task configuration for a MongoDB instance. |
| ModifyBackupExpireTime | ModifyBackupExpireTime | Modifies the time-to-live (TTL) of a MongoDB backup set. |