API overview
Updated at:
Copy as MD
The following tables list the API operations available for PolarDB-X 1.0, organized by functional category.
Instance management
| API | Description |
|---|---|
| CreateDrdsInstance | Creates a PolarDB-X 1.0 instance. |
| DescribeDrdsInstance | Queries the details of a specified PolarDB-X 1.0 instance. |
| DescribeDrdsInstances instances in the specified region.") | Queries PolarDB-X 1.0 instances in a specified region. |
| RestartDrdsInstance | Restarts a specified PolarDB-X 1.0 instance. |
| ModifyDrdsInstanceDescription | Modifies the description of a specified PolarDB-X 1.0 instance. |
Database management
| API | Description |
|---|---|
| CreateDrdsDB | Creates a database in a PolarDB-X 1.0 instance. |
| CheckDrdsDbName | Checks whether the name of a specified PolarDB-X 1.0 database is valid. |
| RemoveDrdsDbFailedRecord | Deletes the failure record of a database creation operation. |
| RemoveDrdsDb | Deletes a specified database from a PolarDB-X 1.0 instance. |
| DescribeDrdsDB | Queries the details of a specified database in a PolarDB-X 1.0 instance. |
| DescribeDrdsDBs | Queries all databases in a specified PolarDB-X 1.0 instance. |
Storage management
| API | Description |
|---|---|
| DescribeRdsPerformanceSummary | Queries the performance summary of the ApsaraDB RDS for MySQL instances used as storage resources. |
| DescribeRdsSuperAccountInstances | Queries the privileged accounts of the ApsaraDB RDS for MySQL instances used as storage resources. |
| DescribeDrdsDBCluster | Queries the details of a specified PolarDB cluster in a logical PolarDB-X 1.0 database. |
| DescribeDrdsDbInstance | Queries the details of a specified ApsaraDB RDS for MySQL instance used as storage resources for PolarDB-X 1.0. |
| DescribeDrdsDbInstances | Queries the ApsaraDB RDS for MySQL instances used as storage resources for a specified PolarDB-X 1.0 database. |
| DescribeDrdsDbRdsNameList | Queries the storage instances for a specified PolarDB-X 1.0 database. |
| GetDrdsDbRdsRelationInfo database.") | Queries the structure of storage instances for a specified PolarDB-X 1.0 database. |
| ModifyRdsReadWeight | Modifies the read and write weights of the ApsaraDB RDS for MySQL instances used as storage resources. |
| ModifyPolarDbReadWeight | Modifies the read and write weights of a specified PolarDB cluster used as storage resources. |
| ResetDrdsToRdsConnections | Resets the number of connections from a PolarDB-X 1.0 instance to its ApsaraDB RDS for MySQL storage instances. |
| DescribeRDSPerformance | Queries the performance data of the ApsaraDB RDS for MySQL instances used as storage resources. |
| DescribeDbInstances | Queries the storage-layer instances, such as ApsaraDB RDS for MySQL or PolarDB. |
| DescribeDbInstanceDbs | Queries the databases on a specified storage instance. |
| DescribeStorageInstanceSubDbInfo | Queries the sub-database information for a specified storage instance. |
| DescribeRdsCommodity | Queries the sales data about ApsaraDB RDS for MySQL that serves as storage resources. |
Account management
| API | Description |
|---|---|
| CreateInstanceAccount | Creates an account for a specified PolarDB-X 1.0 instance. |
| DescribeInstanceAccounts | Queries the accounts of a specified PolarDB-X 1.0 instance. |
| RemoveInstanceAccount | Deletes a management account from a specified PolarDB-X 1.0 instance. |
Backup and recovery
| API | Description |
|---|---|
| StartRestore | Starts a backup-based restore task for a specified PolarDB-X 1.0 instance. |
| RemoveBackupsSet | Deletes a specified backup set. |
| DescribeBackMenu | Checks whether a specified PolarDB-X 1.0 instance supports backup and recovery. |
| DescribeBackupTimes | Queries the point in time to which a specified instance can be restored. |
| DescribeRestoreOrder | Queries the details of the current purchase order for a recovery operation. |
| DescribeBackupDbs | Queries the databases that can be restored for a specified instance. |
| PutStartBackup | Submits a data backup task for a specified PolarDB-X 1.0 instance. |
| SetBackupPolicy | Sets the backup policy for a specified PolarDB-X 1.0 instance. |
| EnableSqlFlashbackMatchSwitch | Enables query logging in the binary log of the storage-layer ApsaraDB RDS for MySQL instances to support accurate data recovery during SQL flashback. |
| DescribeBackupSets | Queries the backup sets for a specified PolarDB-X 1.0 instance. |
Network and connection
| API | Description |
|---|---|
| ReleaseInstanceInternetAddress | Releases the public endpoint of a specified PolarDB-X 1.0 instance to ensure instance security. |
| DescribeInstanceSwitchNetwork | Checks whether the network type of a specified instance can be switched. |
| CreateInstanceInternetAddress | Creates a public IP address for a specified PolarDB-X 1.0 instance. |
| RefreshDrdsAtomUrl | Refreshes the connections between a PolarDB-X 1.0 instance and its ApsaraDB RDS for MySQL storage instances after a connection change. |
Task management
| API | Description |
|---|---|
| DescribeSqlFlashbakTask instance.") | Queries the SQL flashback tasks for a specified PolarDB-X 1.0 instance. |
| DescribeDrdsInstanceLevelTasks | Queries the pending instance-level tasks for a specified PolarDB-X 1.0 instance. |
| SubmitSqlFlashbackTask | Submits an SQL flashback task. |
| DescribePreCheckResult | Queries the precheck result of a specified task. |
| DescribeDrdsTasks | Queries the change tasks for a specified PolarDB-X 1.0 instance. |
Table sharding
| API | Description |
|---|---|
| ValidateShardTask | Checks whether a sharding task is valid. |
| DescribeExpandLogicTableInfoList | Queries the shard key information for logical table expansion. |
| DatalinkReplicationPrecheck | Runs a precheck on a data link replication task. |
| CreateShardTask | Creates a sharding task. |
| DescribeShardTaskInfo | Queries the details of a specified sharding task. |
| DeleteShardTasks | Deletes a specified sharding task. |
Data table management
| API | Description |
|---|---|
| DescribeTables | Queries the tables in a specified PolarDB-X 1.0 database. |
| DescribeTableListByType | Queries tables of a specified type in a PolarDB-X 1.0 database. |
| DescribeTable | Queries the schema of a specified table. |
| SetupTable | Configures the full table scan setting for a specified table. |
Tag and parameter settings
| API | Description |
|---|---|
| TagResources | Adds tags to a specified PolarDB-X 1.0 instance. |
| UntagResources | Removes tags from a specified PolarDB-X 1.0 instance. |
| ListTagResources | Queries the tags on a specified PolarDB-X 1.0 instance. |
| DescribeDrdsParams | Queries the parameters of a specified PolarDB-X 1.0 instance. |
| SetupDrdsParams | Configures parameters for a specified PolarDB-X 1.0 instance. |
Instance version
| API | Description |
|---|---|
| DescribeDrdsInstanceVersion | Queries the version of a specified PolarDB-X 1.0 instance. |
| RollbackInstanceVersion | Rolls back the version of a specified PolarDB-X 1.0 instance. |
| UpgradeInstanceVersion | Upgrades the version of a specified PolarDB-X 1.0 instance. |
Performance monitoring
| API | Description |
|---|---|
| DescribeDrdsInstanceMonitor | Queries the monitoring data for a specified PolarDB-X 1.0 instance. |
| DescribeDrdsInstanceDbMonitor | Queries the performance monitoring data for a specified PolarDB-X 1.0 database. |
Others
| API | Description |
|---|---|
| DescribeDrdsDBIpWhiteList | Queries the IP address whitelist of a specified PolarDB-X 1.0 database. |
| ModifyDrdsIpWhiteList | Modifies the IP whitelist of a specified PolarDB-X 1.0 database. |
| DescribeInstanceSwitchAzone | Checks whether a specified PolarDB-X 1.0 instance supports zone switching. |
| DescribeDrdsSlowSqls | Queries the slow SQL records for a specified PolarDB-X 1.0 instance. |
Is this page helpful?