API Category
Last updated: 2025-10-24 14:50:33
API Category
Last updated: 2025-10-24 14:50:33
Health Report Email Sending APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| AddUserContact | Adds the recipient information | 20 |
| CreateDBDiagReportTask | Creates a health report generation task | 20 |
| CreateDBDiagReportUrl | Creates a URL for a health report | 20 |
| CreateMailProfile | Creates the email configuration | 20 |
| CreateSchedulerMailProfile | Creates the scheduled task email sending configuration | 20 |
| DescribeAllUserContact | Gets the information of the recipient in the email | 20 |
| DescribeAllUserGroup | Gets the information of the recipient group in the email | 20 |
| DescribeDBDiagReportTasks | Queries the list of health report generation tasks | 20 |
| DescribeMailProfile | Gets the email configuration | 20 |
| DeleteDBDiagReportTasks | Deletes health report generation tasks | 20 |
Session Killing APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateKillTask | Creates a session killing task | 20 |
| CreateProxySessionKillTask | Creates a task of killing proxy node sessions | 20 |
| DescribeProxyProcessStatistics | Gets the session statistics of a single proxy | 20 |
| DescribeProxySessionKillTasks | Queries the status of the session killing task executed by the proxy node | 20 |
| KillMySqlThreads | Kills a MySQL session thread | 20 |
Security Audit APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateSecurityAuditLogExportTask | Creates a security audit log export task | 20 |
| DeleteSecurityAuditLogExportTasks | Deletes a security audit log export task | 20 |
| DescribeSecurityAuditLogDownloadUrls | Queries the download link of a security audit log export file | 20 |
| DescribeSecurityAuditLogExportTasks | Queries the list of security audit log export tasks | 20 |
Exception Detection APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeDBDiagEvent | Gets diagnosis event details | 20 |
| DescribeDBDiagEvents | Obtains diagnosis event list | 20 |
| DescribeDBDiagHistory | Gets the instance diagnosis history | 20 |
Space Analysis APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeDBSpaceStatus | Gets the overview of instance space usage during the specified time period | 20 |
| DescribeTopSpaceSchemaTimeSeries | Gets the daily space statistics of top databases during the specified time period | 20 |
| DescribeTopSpaceSchemas | Gets the space statistics of top databases | 20 |
| DescribeTopSpaceTableTimeSeries | Gets the daily space statistics of top tables during the specified time period | 20 |
| DescribeTopSpaceTables | Gets the space statistics of top tables | 20 |
Other APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeDiagDBInstances | Gets instance information list | 20 |
| DescribeHealthScore | Gets the health score | 20 |
| DescribeMySqlProcessList | Queries the list of real-time threads | 20 |
| ModifyDiagDBInstanceConf | Enables/Disables instance inspection | 20 |
| CreateRedisBigKeyAnalysisTask | Creates an ad hoc big key analysis task for Redis instances | 20 |
Slow Log Analysis APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeSlowLogTimeSeriesStats | Gets the slow log statistics histogram | 20 |
| DescribeSlowLogUserHostStats | Gets the statistical distribution chart of slow log source addresses | 20 |
| DescribeUserSqlAdvice | Gets SQL statement optimization suggestions | 20 |
| DescribeSlowLogTopSqls | Obtains the list of slow SQL templates | 20 |
| DescribeSlowLogs | Obtains SQL template details in a specified time period | 20 |
Database Audit APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CloseAuditService | Disables database audit | 20 |
| ModifyAuditService | Modifies audit configurations | 20 |
| OpenAuditService | Enables database audit | 20 |
| DescribeAuditInstanceList | Queries the instance list | 20 |
Redis related APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeRedisTopKeyPrefixList | Queries the list of top key prefixes for Redis instances | 20 |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback