This section lists the function names and corresponding descriptions of RDS for MySQL API of eSurfing Cloud Database by category. For the use methods and examples of the API
Account
Name | Description |
Querying Reserved Keyword | Query MySQL reserved keywords, i.e. keywords disabled when creating a database or account number. |
Revoking Account Permissions | Revoke the account access to the database. |
Revoking Service Account Permissions | Revoke the database DML or DDL basic permissions for an account. |
Creating a General Database Account | Create a general database account and grant permissions to the user account. |
Obtaining Permission Granting Details of an Instance Database Account | Call the interface to query the permission granting details of a database account. |
Obtaining Database Account Information for an Instance | Obtain the database account information for an instance based on userId and prodInstId. |
Deleting the Database Account Created By the User | Delete the database account created by the users based on instance ID and account name. |
Authorizing Account Permissions | An account can be authorized with read-only or full access to one or more databases. |
Authorizing Service Account Permissions | An account can be authorized with DML or DDL basic permissions to one or more databases. |
Resetting Database Account Password | Reset database account password by instance ID and account name. |
Resetting Permissions for a High-Permission Account | Reset the permissions for a high-permission account. |
Backup
Name | Description |
Querying the Backup Set List for RDS Instances | Query the backup set list for RDS instances. |
Modifying Backup Settings | Modify backup settings. |
Deleting Data Backup Files | Delete the data backup files. |
Creating a Backup Set | Call the interface to create a backup set. |
Querying the Backup Task List under an RDS Instance | Query the backup task list under an RDS instance. |
Querying the RDS Instance Backup Settings | Query the RDS instance backup settings. |
Viewing the Backup Set List for a Deleted Instance | Query the backup set list for a deleted instance, that is, the backup set list for unsubscribed instances that are not recycled. |
Querying the Restorable Time Range of RDS Instance Backups | Query the restorable time range of specified RDS instance backups. |
Querying the Cross-region Backup Settings of an RDS Instance | Query the cross-region backup settings of an RDS instance. |
Querying the Cross-Region Data Backup File List of an RDS Instance | Query the cross-region data backup file list of an RDS instance. |
Querying Regions Supporting Cross-Region Backups | Query the destination regions that support cross-region backups in the selected region. |
Querying Cross-Region Backup Instances | Query the RDS instances with cross-region backups enabled and their cross-region backup settings in the selected region. |
Restoring Data (Clone Instance) | Restore the data (Clone instance). |
Database
Name | Description |
Checking the Database Name Availability | Check if database name is available. |
Querying Database Information under an RDS Instance | Query database information under an RDS instance. |
Querying the Character Sets Supported by an RDS Instance | Query the character sets supported by an RDS instance. |
Querying SSL Settings for an RDS Instance | Query SSL settings for an RDS instance. |
Creating a Database | Create a database. |
Deleting a Database | Delete a database. |
Modifying the RDS Instance SSL Link | Call the interface to modify the RDS instance SSL link. |
Instance
Name | Description |
Querying RDS Instance Details | Query the basic instance details based on the database instance ID. |
Querying the Existence of an RDS Instance | Query if an RDS instance exists. |
Querying Enabling of Task Center | Query if the Instance Task Center function is enabled. |
Querying the Task Center Task Information | Query the Task Center task information. |
Querying Instance Binlog Information | Query the binlog information for the node under a specified RDS instance. Return the empty query results if binlog switch is not enabled. |
Querying the High Availability Mode of an Instance | Query the replication mode of high availability mode by instance ID. |
Querying Instance Connection Information | Call the interface to query all connection information of an instance. |
Querying the Instance List | Query the instance list. |
Querying Instance Information by Expiration Time | Query the instance list by parameters such as expiration time and expiration state. |
Modifying the Instance Name | Modify the instance name. |
Restarting an Instance | Restart an instance based on the database instance ID. |
Modifying the Instance Write Port | Modify the write port of the connected instance, asynchronous request |
Querying the Node List | Query the node list. |
Switching the Primary/Standby Instances of an RDS Instance | Switch the primary/standby instances of an RDS instance. |
Enabling or Disabling the Automatic Master-Slave Switching Function of an RDS Instance | Enable or disable the automatic Master-Slave Switching function of an RDS instance. |
Querying the Automatic Master-Slave Switching Settings of an RDS Instance | Query the automatic master-slave switching settings of an RDS instance. |
Querying Salable Resources | Call the interface to query the salable resource information in a certain region. |
Querying the EIP List | Query the EIP list. |
Querying Availability Zone Resources | Query the RDS availability zone information. |
Querying Instance Resource Information | Query instance resource information. |
Querying Geographical Information | Query the current optional RDS region and AZ information |
Querying Available Specification Information | Query all specification details of an RDS instance. |
Querying the Variable Specifications of an Instance | Query variable specifications of an instance. |
Querying Resource Pool Information | Call the interface to query resource pool information. |
Starting an RDS Instance | Start an RDS instance based on the instance ID. |
Requesting the Extranet Address for an RDS Instance | Request the extranet address for an RDS instance. |
Releasing the Extranet Address of an RDS Instance | Release the extranet address of an RDS instance |
Pausing an RDS Instance | Pause an RDS instance based on the instance ID. |
Querying the Security Group List | Query the security group list. |
Upgrading the Minor Kernel Version | Upgrade the minor kernel version of an RDS instance. |
Modifying the Security Group of an RDS Instance | Modify the security group of an RDS instance. |
Enabling or Disabling the Historical Event Function of an RDS Instance | Enable or disable the historical event function of an RDS instance. By default, this function is enabled or disabled for all instances under the account. |
Querying the Master-Slave Switching Records | Query the master-slave switching records. |
Log
Name | Description | Description |
Querying the Slow Log Statistics of an RDS Instance | Query the slow log statistics of an instance. | |
Querying the Slow Log Details of an RDS Instance | Query the slow log details of an instance. | |
Querying the Error Logs Over a Period for an RDS Instance | Query the error logs over a period for an RDS Instance. | |
Querying the SQL Insight (SQL Audit) Logs for an RDS Instance | Call the interface to query the SQL Insight (SQL Audit) logs for an instance. | |
Querying the Retention Period of SQL Insight Logs for an RDS Instance | Call the interface to query the SQL Insight log retention period of SQL insight logs for an RDS instance. | |
Querying Enabling/Disabling of the SQL Audit or SQL Insight Function of an RDS Instance | Call the interface to query whether the SQL Insight (SQL Audit) function of an RDS instance is enabled or not. | |
Querying the SQL Insight (SQL Audit) File List | Call the interface to query the SQL Insight (SQL Audit) log list. | |
Enabling or Disabling the SQL Insight (SQL Audit) Function for an Instance | Call the interface to enable or disable the SQL Insight (SQL Audit) function for an instance. |
Monitoring
Name | Description |
Querying Performance Data for an RDS Instance | Query the performance monitoring data for a certain instance during a certain period according to performance parameters. |
Querying the Space Usage Information for an RDS Instance | Query the space usage information for an RDS instance. |
Querying the Instance Monitoring Frequency | Query the instance monitoring frequency. |
Modifying the Instance Monitoring Frequency | Modify the instance monitoring frequency. |
Parameter
Name | Description |
Querying the Parameter Modification Logs of an RDS Instance | Query the parameter modification logs of an RDS instance. |
Querying the Maximum Number of Files That the InnoDB Data Table Driver Can Open at the Same Time | Query the maximum number of files that the InnoDB data table driver can open at the same time. |
Querying the Timeout to Obtain Metadata Lock | Query the timeout to obtain metadata lock. |
Querying the Enabling/Disabling of Slow Query | Query whether the slow query is enabled or not. |
Querying the Maximum Allowable Packet Size | Query the maximum allowable packet size. |
Querying the Maximum Number of Broken Connections | Query the maximum number of broken connections. |
Querying the Maximum Number of Write Locks | Query the maximum number of write locks max_write_lock_count. |
Querying the Index Buffer Size | Query the index buffer size. |
Querying the Specific RDS Parameter Template Information | Query the RDS parameter template information based on the template ID. |
Creating a Parameter Template | Query the basic instance details based on the database instance ID |
Obtaining the Parameter Template List | Obtain the parameter template list information. |
Obtaining Parameter Template Details | Obtain the parameter template details. |
Deleting a Parameter Template | Delete the parameter template based on ID. |
Modifying the RDS Parameter | Modify the RDS parameter. |
Modifying the Parameter Template Value | Modify the parameter template value based on the parameter template ID. |
Querying the Current Parameter Configuration of the RDS Instance | Query the current parameter configuration of the instance. |
Copying the Parameter Template | Copy the parameter template. |
Order
Name | Description |
Changing the RDS Instance | Call the interface and place an order to change the RDS instance. |
Querying the RDS Instance Price | Call the interface to obtain the price of an instance through the specification parameter. |
Querying the RDS Instance Renewal Fee | Call the interface to query the renewal instance cost. |
Querying the Changed RDS Instance Price | Call the interface to obtain the price of the changed instance through the specification parameter. |
Querying the Read-Only Instance Price | Call the interface to obtain the price of the read-only instance through the specification parameter. |
Creating an RDS Instance | Call the interface to place an instance order |
Creating a Read-Only Instance | Call the interface to create a read-only instance for an instance. |
Releasing an RDS Instance | Call the interface to release an instance. |
Manually Renewing an RDS Instance | Call the interface to place a renewal instance order. |
Changing the Billing Mode of an RDS Instances | Change the billing method of RDS instances to Payment by Volume or Package Cycle. At present, only changing to Payment by Volume is supported. |
Label
Name | Description |
Creating and Binding a Label for the Specified RDS Instance | Create and bind a label for the specified RDS instance. If a label already exists, the created label will overwrite it. |
Unbinding a Label from a Specified RDS Instance | Unbind a label from a specified RDS instance. |
Querying the Label List | Query the label list. |
Notification
Name | Description |
Querying the RDS Notification List | Call the interface to query the RDS notification list. |
Confirming the Notification | Call the interface to confirm the RDS notification. |
Status Code
The list of return status codes for this product interface request is as follows.
Status Code | Description |
0 | Successful |
2001 | Parameter exception. See the message for fault reasons. |
3001 | Business exception. See the message for fault reasons. |
5001 | Request response exception. See the message for fault reasons. |