API overview

Last Updated: Dec 08, 2017

Life-cycle

APIDescription
CreateDBInstanceCreates replica set instances.
ModifyDBInstanceSpecChanges configurations for replica set instances.
DeleteDBInstanceReleases an instance.
RenewDBInstanceRenews replica set instances.
CreateShardingDBInstanceCreates sharded cluster instances.
CreateNodeAdds cluster instance components.
DeleteNodeDeletes cluster instance components.
ModifyNodeSpecChanges configuration for cluster instances.

Instance management

APIDescription
DescribeRegionsQueries the list of available regions.
DescribeDBInstancesQueries the instance list.
RestartDBInstanceRestarts the instance.
ModifyDBInstanceMaintainTimeModifies the instance maintenance time.
ModifyDBInstanceDescriptionModifies instance remarks.
DescribeDBInstanceAttributeQueries instance details.
DescribeReplicaSetRoleQueries replica set roles and connection information.
DescribeShardingNetworkAddressQueries sharded cluster connection information.
ModifyDBInstanceNetworkTypeSwitches the instance type.
ModifyDBInstanceNetExpireTimeProlongs retention period of classic networks.

Account management

APIDescription
DescribeAccountsQueries the account.
ResetAccountPasswordResets the password.

Database security management

APIDescription
DescribeSecurityIpsQueries the instance access whitelist.
ModifySecurityIpsModifies the instance access whitelist.
DescribeAuditRecordsQueries the audit log.
DescribeAuditFilesQueries audit log files.

Backup recovery management

APIDescription
DescribeBackupPolicyViews the backup policy.
ModifyBackupPolicyModifies the backup policy.
CreateBackupCreates backups.
DescribeBackupsViews the backup list.
RestoreDBInstanceRecovers the data.

Monitoring alarm management

APIDescription
DescribeDBInstancePerformanceQueries the instance performance data.
Thank you! We've received your feedback.