This product(
Dds/2015-12-01) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Instance creation or cloning
| API | Title | Description |
|---|---|---|
| CreateDBInstance | CreateDBInstance | Creates or clones an ApsaraDB for MongoDB replica set instance. |
| CreateShardingDBInstance | CreateShardingDBInstance | Creates or clones an ApsaraDB for MongoDB sharded cluster instance. |
Instance configuration change
| 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 | Modifies the specifications or storage space of an ApsaraDB for MongoDB standalone, replica set, or serverless instance. Serverless instances are available only on the China site (aliyun.com). |
| ModifyNodeSpec | ModifyNodeSpec | Changes the specifications and storage capacity of a node of an ApsaraDB for MongoDB sharded cluster instance. |
| ModifyNodeSpecBatch | ModifyNodeSpecBatch | Changes the configurations of 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 an ApsaraDB for 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 node in an ApsaraDB for 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 fees incurred when you create, upgrade, or renew an ApsaraDB for MongoDB instance. |
| DescribeRenewalPrice | DescribeRenewalPrice | Queries the price of renewing an ApsaraDB for 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. |
Instance information query
| API | Title | Description |
|---|---|---|
| DescribeReplicaSetRole | DescribeReplicaSetRole | Queries the role and connection information of an ApsaraDB for 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 ApsaraDB for 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 | Queries 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 scheduled O\\\&M tasks of an ApsaraDB for 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 information of one or more ApsaraDB for MongoDB instances. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | Queries the overview of a task in the task center. |
| DescribeHistoryTasks | DescribeHistoryTasks | Queries a list of tasks 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 | Checks whether sufficient resources are available in a region in which you want to create or upgrade an ApsaraDB for MongoDB 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. |
Resource 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 endpoint that is used to connect to an ApsaraDB for MongoDB instance. |
| DescribeShardingNetworkAddress | DescribeShardingNetworkAddress | Queries connection information about an ApsaraDB for 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 in 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 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. |
IP address whitelists and security groups
| API | Title | Description |
|---|---|---|
| ModifySecurityIps | ModifySecurityIps | Modifies the IP address whitelists of an ApsaraDB for MongoDB instance. |
| ModifySecurityGroupConfiguration | ModifySecurityGroupConfiguration | Modifies the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB for MongoDB instance. |
| DescribeSecurityIps | DescribeSecurityIps | Queries the IP address whitelist 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 global IP whitelist templates associated with an ApsaraDB for MongoDB instance. |
| 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 whitelist template. |
Keys
| API | Title | Description |
|---|---|---|
| ModifyDBInstanceTDE | ModifyDBInstanceTDE | Modifies the transparent data encryption (TDE) status of an ApsaraDB for 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 of an ApsaraDB for MongoDB 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 settings of an ApsaraDB for MongoDB instance. |
| DescribeDBInstanceSSL | DescribeDBInstanceSSL | Queries the Secure Sockets Layer (SSL) settings of an ApsaraDB for 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 | Enables or disables the audit log feature or configures the log storage duration for an ApsaraDB for MongoDB instance. |
| DescribeAuditRecords | DescribeAuditRecords | Queries the audit logs of an ApsaraDB for MongoDB instance. |
| DescribeAuditPolicy | DescribeAuditPolicy | Queries whether the audit log feature is enabled for an ApsaraDB for MongoDB instance. |
| DescribeAuditLogFilter | DescribeAuditLogFilter | Queries the types of entries in the audit log collected for an ApsaraDB for MongoDB instance. |
| DescribeMongoDBLogConfig | DescribeMongoDBLogConfig | Queries the logging configurations of an ApsaraDB for MongoDB instance. |
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 entries in operational logs of an ApsaraDB for MongoDB instance. |
Performance monitoring management
| 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 an ApsaraDB for 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 list of default parameter templates for ApsaraDB for MongoDB instances. |
| DescribeParameters | DescribeParameters | Queries the parameter settings of an ApsaraDB for MongoDB instance. |
Backup and restoration
| API | Title | Description |
|---|---|---|
| CreateBackup | CreateBackup | Creates a backup set for an ApsaraDB for MongoDB instance. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies a backup policy for an ApsaraDB for MongoDB instance. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup policy of an ApsaraDB for MongoDB instance. |
| DescribeBackups | DescribeBackups | Queries the backup sets of an ApsaraDB for 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 backup sets of an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks. |
| DescribeClusterRecoverTime | DescribeClusterRecoverTime | Queries the time range to which you can restore the data of an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks. |
| DescribeBackupStorage | DescribeBackupStorage | Queries the storage used for backup in an ApsaraDB for MongoDB replica set or sharded cluster instance that uses cloud disks. Note that you are charged only for the backup-used storage of each shard in a sharded cluster instance. You can call this operation only to query the storage used by a single shard in the instance for backup. |
| DescribeBackupTasks | DescribeBackupTasks | Queries backup tasks running in an ApsaraDB for MongoDB replica set or sharded cluster instance that uses cloud disks. |
| DescribeInstanceRecoverTime | DescribeInstanceRecoverTime | Queries the time required to restore the data of an ApsaraDB for MongoDB replica set instance that uses cloud disks. |