MySQL API Overview

Last updated: 2019-12-27 14:47:59

    API Function Action Name Description
    Query Instance List DescribeCdbInstances Query the list of cloud database instances. It can use IDs, access addresses and status, and the likes of cloud database instances as filtering conditions to query the list of instances.
    Query Read-only Instance List GetCdbReadOnlyInstances Query the list of read-only instances. You can input one or more master instance IDs to query the list of read-only instances associated with the master instance(s)
    Create Instance (Pay-by-usage) CreateCdbHour Create cloud database instances, with the billing model of Pay-by-usage
    Query Price (Pay-by-usage) InquiryCdbPriceHour Query the pay-by-usage price of a certain type of Cloud Database instance
    Query Supported Specifications(supporting custom availability zones and configurations) DescribeCdbProductListNew Query supported specifications of cloud database instances, and support the creation of instances according to availability zones and custom specifications. Recommended to use
    Query Supported Specifications DescribeCdbProductList Query supported specifications of cloud database instances
    Initialize Instance CdbMysqlInit Initialize a cloud database instance, and meanwhile can set the character set, port, root account password and table name case sensitivity of the instance during initialization.
    Query Details on Initialization Task GetCdbInitInfo Query details on the progress of the asynchronous task about initializing a cloud database instance through the initialization task ID
    Upgrade Instance UpgradeCdb Upgrade cloud database instances. Instance types include master instance, disaster recovery instance and read-only instance.
    Query Upgrade Price InquiryCdbUpgradePrice Query the upgrade price of a cloud database instance. Instance types include master instance, disaster recovery instance and read-only instance.
    Upgrade Database Engine Version UpgradeCdbEngineVersion Upgrade the engine version of a cloud database instance
    Query Details on Instance Upgrade Task GetCdbUpgradeJobInfo Query details on instance upgrade task. The query of upgrade details on master instances, disaster recovery instances and read-only instances are supported.
    Terminate Instance (Pay-by-usage) CloseCdbHour Instances in pay-by-usage mode can be terminated in real time
    Recover Instance (Pay-by-usage) OpenCdbHour Instances in pay-by-usage mode, if terminated, can be recovered in real time through this API
    Modify Parent Project ModifyCdbInstanceProject Modify the project a cloud database instance belongs to
    Reset Password ResetCdbInstancesPassword Reset the password of the root account of a cloud database instance
    Modify Name ModifyCdbInstanceName Modify the name of a cloud database instance
    Modify Port ModifyCdbInstanceVport Modify the port of a cloud database instance, with supported port value range of 1024-65535
    Modify Character Set ModifyCdbCharset Modify the character set of a cloud database instance
    Enable Public Network Access OpenCdbExtranetAccess Enable the public network access to a cloud database instance. After public network access is enabled, you can access an instance through the domain and port of a public network
    Disable Public Network Access CloseCdbExtranetAccess Disable the public network access to a cloud database instance. After public network access is disabled, public network addresses will be inaccessible
    Switch Disaster Recovery Instance to Master Instance SwitchCdbDrToMaster Switch a disaster recovery instance to a master instance in the cloud database. The region in the common parameters is the region where the disater recovery instance resides in
    Enable GTID OpenCdbGtid Enable the GTID of a cloud database instance
    Query GTID Details on Instance GetCdbGtidInfo Query details on instance's GTID
    Query Number of Instances in Subnet of VPC GetCdbInstanceNumByVpcSubnetId Query the number of cloud database instances under the subnet of a VPC

    API Function Action Name Description
    Query Account List GetCdbInstanceAccountList Query the account list of a database
    Create Account CreateCdbInstanceAccount Create the account of a database
    Query Permissions Settable for Account GetCdbInstanceAccountAvailablePrivileges Query permissions that can be set for the account of a cloud data instance
    Query Account Permissions GetCdbInstanceAccountPrivileges Query account permissions for a cloud data instance
    Modify Account Permission ModifyCdbInstanceAccountPrivileges Modify access permission of the account for a cloud data instance
    Delete Account DelCdbInstanceAccount Delete a database account
    Modify Account Notes ModifyCdbInstanceAccountRemarks Modify the notes of a database account
    Modify Account Password ModifyCdbInstanceAccountPassword Modify the account password for a cloud database instance

    API Function Action Name Description
    Query Database Schema GetCdbInstanceSchema Query details on a database schema
    Query Database QueryCdbDatabases Query database information of a cloud database instance
    Query Database Table QueryCdbDatabaseTables Query database table information of a cloud database instance

    API Function Action Name Description
    Query Details on Default Parameter Template GetCdbDefaultParamInfo Query details on the default template for database parameters
    Query List of Parameter Templates GetCdbParamTemplateList Query the list of templates for database parameters
    Add Parameter Template AddCdbParamTemplate Add a template for database parameters
    Delete Parameter Template DelCdbParamTemplate It deletes a template for database parameters
    Query Details on Parameter Template GetCdbParamTemplateInfo Query details on the template for cloud database parameters
    Modify Parameter Template ModifyCdbParamTemplate Modify contents of the template for database parameters
    Query List of Parameters GetCdbParams Query the list of database parameters using instance IDs
    Modify Parameter ModifyCdbParams Modify database parameters, and return task ID of parameter modification after successful submission
    Query Modification Record of Parameters GetCdbParamsModifyHistory Query the modification record of database parameters
    Query Details on Parameter Modification Task GetCdbModifyParamsJobTask Query details on parameter modification task through task ID of parameter modification

    API Function Action Name Description
    Query Monitoring Information of Physical Machine GetCdbDeviceMonitorInfo Query monitoring information of a physical machine, temporarily only supporting the query of instances with highest configuration
    Query Statistics QueryCdbStatisticsInfo Query statistics of a cloud database; query only statistics within last minute

    API Function Action Name Description
    Upload Imported File UploadCdbImportSQLFile Used to upload imported file
    Start File Import Task StartCdbImportJob Used to start a file import task
    Terminate File Import Task StopCdbImportJob Used to terminate a file import task
    Query List of Imported Files GetCdbImportSQLFileList Used to query the list of imported files
    Query Record of Recently Imported Files GetCdbImportSQLFileHistory Used to query the record of recently imported files

    API Function Action Name Description
    Query Details on Rollback Task GetCdbRollbackJobTask Query details on the rollback task performed on a cloud database instance
    Query List of Rollback Tasks GetCdbRollbackJob Query the list of rollback tasks performed on a cloud database instance
    Query Rollback Time QueryCdbRollbackRangeTime Query the time span during which a cloud database instance can be rolled back
    Run Database Table Rollback RollbackCdbDatabaseTables Roll back database tables of a cloud database instance in batch

    API Function Action Name Description
    Query Backups and Logs GetCdbExportLogUrl Query cold backup data, binary logs and slow query logs of an instance
    Query Database Table for Backup Data GetBackupDatabaseTableList Query database tables for backup data
    Query Backup Address (Query by Table is Supported) GetExportBackupUrl Query addresses of backup data, and support query by database table
    Modify Backup Information ModifyCdbBackupInfo Modify backup information, for example, the backup name

    API Function Action Name Description
    Query Task List GetCdbJobList Query the list of tasks performed on a cloud database

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help