API standards and multilingual preset SDKs
The OpenAPI of this product (Dds/2015-12-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Create or clone instances
|
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. |
Change instance configurations
|
API |
Title |
Description |
| CreateNode | CreateNode | Adds a shard node or a mongos node to an ApsaraDB for MongoDB sharded cluster 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 space for ApsaraDB for MongoDB standalone, replica set, or serverless instances. Serverless instances are exclusive to the Alibaba Cloud China website. |
| 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. |
| SwitchDBInstanceHA | SwitchDBInstanceHA | Switches the primary and secondary nodes for an ApsaraDB for MongoDB instance. |
| RestartDBInstance | RestartDBInstance | Restarts an ApsaraDB for MongoDB instance. |
| RestartNode | RestartNode | Restarts a single node of a MongoDB instance. |
Renewal management
|
API |
Title |
Description |
| 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 | Query prices. |
| DescribeRenewalPrice | DescribeRenewalPrice | Get the price to renew a specific MongoDB instance for one month. |
| 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 | Retrieves the role information and connection details 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 information about an ApsaraDB for MongoDB instance. |
| DescribeRoleZoneInfo | DescribeRoleZoneInfo | Queries the role and zone of each node in an ApsaraDB for MongoDB instance. |
| DescribeInstanceAutoRenewalAttribute | DescribeInstanceAutoRenewalAttribute | Queries the auto-renewal status of MongoDB instances. |
| DescribeActiveOperationTaskCount | DescribeActiveOperationTaskCount | Queries the number of operation and maintenance tasks on an ApsaraDB for MongoDB instance. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries O&M task details for MongoDB instances. |
| 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. |
Resource management
|
API |
Title |
Description |
| DescribeAvailableResource | DescribeAvailableResource | Queries the available resources in the specified zone. |
| EvaluateResource | EvaluateResource | Evaluate resource availability before purchasing a new instance or changing the configuration of 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 | Migrates 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 | Switch the network type of an instance | Switches the network type of a MongoDB instance. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | Modifies the connection address and port of a MongoDB instance. |
| DescribeShardingNetworkAddress | DescribeShardingNetworkAddress | Retrieves 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 | Modifies the ECS security group bound to an ApsaraDB for MongoDB instance. |
| DescribeSecurityIps | DescribeSecurityIps | Retrieves the IP whitelists of 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. |
| 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 encryption key of a MongoDB instance. |
| DescribeDBInstanceTDEInfo | Query whether TDE is enabled for a mongoDB instance | 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 | Query SSL configuration details for a MongoDB instance. |
Audit logs
|
API |
Title |
Description |
| ModifyAuditLogFilter | ModifyAuditLogFilter | Modifies the audit log types collected for a MongoDB instance. |
| ModifyAuditPolicy | ModifyAuditPolicy | Enables or disables the audit log for a MongoDB instance, or modifies the log retention period. |
| DescribeAuditRecords | DescribeAuditRecords | Queries audit log entries for a MongoDB instance. |
| DescribeAuditPolicy | DescribeAuditPolicy | Checks whether audit logging is enabled for a MongoDB instance. |
| DescribeAuditLogFilter | DescribeAuditLogFilter | Queries the audit log types collected for a MongoDB instance. |
| DescribeMongoDBLogConfig | DescribeMongoDBLogConfig | You can view the configuration of MongoDB Log Service. |
Log management
|
API |
Title |
Description |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries slow query log entries for a MongoDB instance. |
| DescribeErrorLogRecords | DescribeErrorLogRecords | Queries error log entries for a MongoDB instance. |
| DescribeRunningLogRecords | DescribeRunningLogRecords | View the running logs for a MongoDB instance. |
Performance monitoring
|
API |
Title |
Description |
| ModifyDBInstanceMonitor | ModifyDBInstanceMonitor | Set the monitoring collection granularity for a 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. |
| 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 | Query restorable time range of a sharded cluster | Queries the restorable time range of a sharded cluster instance that uses cloud disks in ApsaraDB for MongoDB. |
| 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 | Query restorable time ranges of a replica set instance | Queries the restorable time ranges of an ApsaraDB for MongoDB replica set instance with cloud disks. |
Others
|
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. |
| 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. |
| ModifyDBInstanceConfig | ModifyDBInstanceConfig | Modifies instance configuration |
| ModifyDBInstanceAttribute | ModifyDBInstanceAttribute | Modifies instance release protection configuration. |
| ModifySrvNetworkAddress | ModifySrvNetworkAddress | Modifies the SRV connection address of a MongoDB instance. |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels Operations and Maintenance (O&M) events in a batch. |
| CreateNodeRoleTag | CreateNodeRoleTag | Creates a role tag for an instance node. |
| DescribeRdsVSwitchs | DescribeRdsVSwitchs | Retrieves a list of vSwitches. |
| DescribeRdsVpcs | DescribeRdsVpcs | Retrieves a list of VPCs. |
| DescribeRoleTagStatus | DescribeRoleTagStatus | Describes the status of a tag for a node. |
| DescribeVpcsForMongoDB | DescribeVpcsForMongoDB | Queries a paginated list of VPCs. |
| ModifyActiveOperationMaintenanceConfig | ModifyActiveOperationMaintenanceConfig | Modifies the Operations and Maintenance (O&M) task configuration for a MongoDB instance. |
| DescribeBinlogFiles | DescribeBinlogFiles | Query log backup files for an ApsaraDB for MongoDB instance. |
| ModifyBackupExpireTime | ModifyBackupExpireTime | Modifies the time-to-live (TTL) of a MongoDB backup set. |
| DeleteBackup | DeleteBackup | Deletes a MongoDB backup set. |
| CheckRecoveryCondition | CheckRecoveryCondition | Queries whether the data of an ApsaraDB for MongoDB instance can be restored. |
| CheckServiceLinkedRole | CheckServiceLinkedRole | Checks whether a service-linked role (SLR) is created for an instance. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | Queries the overview of a task in the task center. |
| DescribeSecurityGroupConfiguration | DescribeSecurityGroupConfiguration | Queries the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB for MongoDB instance. |
| DestroyInstance | DestroyInstance | Destroys an ApsaraDB for MongoDB instance. |
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Modifies the switching time of scheduled O\\\\\\&M tasks for an ApsaraDB for MongoDB instance. |
| ModifyGlobalSecurityIPGroup | ModifyGlobalSecurityIPGroup | Modifies the global IP whitelist template associated with an ApsaraDB for MongoDB instance. |
| ModifyGlobalSecurityIPGroupRelation | ModifyGlobalSecurityIPGroupRelation | Modifies the mapping between a global whitelist template and an ApsaraDB for MongoDB instance. |
| ModifyInstanceAutoRenewalAttribute | ModifyInstanceAutoRenewalAttribute | Enables or disables auto-renewal for an ApsaraDB for MongoDB instance. |
| ModifyTaskInfo | ModifyTaskInfo | Modifies the information of a task in the task center for an ApsaraDB for MongoDB instance. |
| UpgradeDBInstanceKernelVersion | UpgradeDBInstanceKernelVersion | Upgrades the minor version of an ApsaraDB for MongoDB instance. |