API Category
Last updated: 2024-11-26 16:32:52
Sales and fee related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateDBInstances | Creates high-availability instances (local disk) | 20 |
| CreateBasicDBInstances | Creates basic edition instances (cloud disk) | 20 |
| CreateCloudDBInstances | Creates high-availability instances (cloud disk) | 20 |
| DescribeRegions | Queries purchasable regions | 20 |
| DescribeZones | Queries purchasable AZs | 20 |
| DescribeProductConfig | Queries purchasable specification configuration | 20 |
| InquiryPriceCreateDBInstances | Queries the price of requested instances | 20 |
| DescribeOrders | Queries order information | 10 |
| DescribeInstanceByOrders | Queries the instance ID by the order number | 20 |
| InquiryPriceUpgradeDBInstance | Queries upgrade price of instance | 20 |
Instance Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeDBInstances | Queries the list of instances | 70 |
| DescribeDBInstancesAttribute | Queries the attributes of an instance | 20 |
| DescribeFlowStatus | Queries flow status | 20 |
| ModifyDBInstanceName | Renames instance | 20 |
| ModifyDBInstanceProject | Modifies project to which database instance belongs | 20 |
| UpgradeDBInstance | Upgrades instance | 20 |
| RestartDBInstance | Restarts instance | 20 |
| TerminateDBInstance | Isolates an instance | 20 |
| RecycleDBInstance | Returns a deactivated SQL Server instance | 20 |
| ModifyDReadable | Enables\Disables the read-only feature of the replica server | 20 |
Network management related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| ModifyDBInstanceNetwork | Changes instance network | 20 |
Account management related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateAccount | Creates instance account | 20 |
| DescribeAccounts | Pulls list of instance accounts | 20 |
| ModifyAccountPrivilege | Modifies instance account permissions | 20 |
| ModifyAccountRemark | Modifies account remarks | 20 |
| ResetAccountPassword | Resets account password | 20 |
| DeleteAccount | Deletes instance account | 20 |
Database APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateDB | Creates database | 20 |
| ModifyDBName | Rename database | 20 |
| ModifyDBRemark | Modifies database remarks | 20 |
| DescribeDBCharsets | Queries the supported database character sets | 20 |
| DeleteDB | Drops database | 20 |
| CloneDB | Clones databases | 20 |
| ModifyDatabaseCDC | Enables/Disables CDC | 20 |
| ModifyDatabaseCT | Enables/Disables CT | 20 |
| DescribeDBs | Queries the list of databases | 20 |
| DescribeDBsNormal | Queries database configurations | 20 |
| ModifyDatabaseMdf | Shrinks database MDF files | 20 |
Data security encryption related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| ModifyInstanceEncryptAttributes | Enables TDE of an instance | 20 |
| ModifyDBEncryptAttributes | Enables or disables TDE of a database | 20 |
Parameter configuration related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeInstanceParams | Queries the configurable parameter list of an instance | 20 |
| ModifyInstanceParam | Modifies instance parameters | 20 |
| DescribeInstanceParamRecords | Queries instance parameter modification records | 20 |
Log management related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeSlowlogs | Gets file information of slow query logs | 20 |
Extended Event APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeXEvents | Queries the list of extended events | 20 |
| StartInstanceXEvent | Starts and stops an extension event | 20 |
Read only instance management related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateReadOnlyDBInstances | Creates read-only instances (local disk) | 20 |
| CreateCloudReadOnlyDBInstances | Creates read-only instances (cloud disk) | 20 |
Backup and Restoration APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateBackup | Creates backup | 20 |
| ModifyBackupStrategy | Modifies backup policy | 20 |
| DescribeBackups | Queries list of backups | 60 |
| DescribeBackupFiles | Queries the details of an unarchived backup | 20 |
Rollback APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeRestoreTimeRange | Queries the time range available for rollback by time point | 20 |
| DescribeRollbackTime | Queries time range available for instance rollback | 20 |
| RollbackInstance | Rolls back the instance by time point | 20 |
| RestoreInstance | Rolls back the database by backup set | 20 |
Data migration (cold standby migration) related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateBackupMigration | Creates backup import tasks | 20 |
| ModifyBackupMigration | Modifies backup import tasks | 20 |
| StartBackupMigration | Starts backup import tasks | 20 |
| DescribeBackupMigration | Queries backup import tasks | 20 |
| DeleteBackupMigration | Deletes backup import tasks | 20 |
| DescribeUploadBackupInfo | Queries backup upload permissions. | 20 |
| CreateIncrementalMigration | Creates incremental backup import tasks | 20 |
| ModifyIncrementalMigration | Modifies incremental backup import tasks. | 20 |
| StartIncrementalMigration | Starts incremental backup import tasks | 20 |
| DescribeIncrementalMigration | Queries incremental backup import tasks | 20 |
| DescribeBackupCommand | Queries the commands of creating backups | 20 |
| DescribeBackupUploadSize | Queries the size of uploaded backup files | 20 |
| DeleteIncrementalMigration | Deletes incremental backup import tasks | 20 |
Data migration (DTS old version) related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateMigration | Creates migration task | 20 |
| ModifyMigration | Modifies migration task | 20 |
| RunMigration | Runs migration task | 20 |
| DeleteMigration | Deletes migration task | 20 |
| DescribeMigrationDetail | Queries migration task details | 20 |
| DescribeMigrations | Queries the list of migration tasks | 20 |
Other APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateBusinessDBInstances | Creates business intelligence service instances (cloud disk) | 20 |
| OpenInterCommunication | Enables instance interconnection | 20 |
| DescribeDBInstanceInter | Queries the information of the interconnected instances | 30 |
| CreateBusinessIntelligenceFile | Creates a business intelligence service file | 20 |
| DescribeBusinessIntelligenceFile | Queries the files required by business intelligence service | 20 |
| DeleteBusinessIntelligenceFile | Deletes a business intelligence service file | 20 |
| CloseInterCommunication | Disables instance interconnection | 20 |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No