This following tables list API operations available for use in PolarDB-X 1.0.
Instance management
| API | Description |
|---|---|
| CreateDrdsInstance | Creates a PolarDB-X 1.0 instance. |
| DescribeDrdsInstance | Queries the details about a specified PolarDB-X 1.0 instance. |
| DescribeDrdsInstances | Queries the list of PolarDB-X 1.0 instances. |
| RestartDrdsInstance | Restarts a specified instance. |
| ModifyDrdsInstanceDescription | Modifies the description of a specified instance. |
Database management
| API | Description |
|---|---|
| CreateDrdsDB | Creates a PolarDB-X 1.0 database. |
| CheckDrdsDbName | Checks whether the name of a specified PolarDB-X 1.0 database is valid. |
| RemoveDrdsDbFailedRecord | Deletes the failure record of creating a database. |
| RemoveDrdsDb | Deletes PolarDB-X 1.0 a specified database in PolarDB-X 1.0. |
| DescribeDrdsDB | Queries the details about a specified database in an instance. |
| DescribeDrdsDBs | Queries the information about all the databases in a specified PolarDB-X 1.0 instance. |
Storage management
| API | Description |
|---|---|
| DescribeRdsPerformanceSummary | Queries the related performance of ApsaraDB RDS for MySQL that serves as the storage resources. |
| DescribeRdsSuperAccountInstances | Queries the privileged accounts for ApsaraDB RDS for MySQL that serves as the storage resources. |
| DescribeDrdsDBCluster | Queries the detailed information about a specified PolarDB cluster in a logical PolarDB-X 1.0 database. |
| DescribeDrdsDbInstance | Queries the details about a specified ApsaraDB RDS for MySQL instance that serves as storage resources for PolarDB-X 1.0. |
| DescribeDrdsDbInstances | Queries the ApsaraDB RDS for MySQL list for a specified PolarDB-X 1.0 database. |
| DescribeDrdsDbRdsNameList | Queries the list of storage instances for a specified PolarDB-X 1.0 database. |
| GetDrdsDbRdsRelationInfo | Queriesthe the structure of storage instances for a PolarDB-X 1.0 database. |
| ModifyRdsReadWeight | Modifies the read and write weights of ApsaraDB RDS for MySQL that serves as storage resources. |
| ModifyPolarDbReadWeight | Modifies the read and write weights of PolarDB. |
| ResetDrdsToRdsConnections | Resets the number of connections from the backend PolarDB-X 1.0 to ApsaraDB RDS for MySQL that serves as storage resources. |
| DescribeRDSPerformance | Queries the performance data about ApsaraDB RDS for MySQL that serves as storage resources. |
| DescribeDbInstances | Queries the list of the instances at the storage layer, such as ApsaraDB RDS for MySQL or PolarDB. |
| DescribeDbInstanceDbs | Queries the list of databases on a storage instance. |
| DescribeStorageInstanceSubDbInfo | Retrieves a storage instance. |
| DescribeRdsCommodity | Queries the sales data about ApsaraDB RDS for MySQL that serves as storage resources. |
Account management
| API | Description |
|---|---|
| CreateInstanceAccount | Creates the account of a specified PolarDB-X 1.0 instance. |
| DescribeInstanceAccounts | Queries the account information about a specified instance. |
| RemoveInstanceAccount | Deletes a specified management account of an instance. |
Backup and recovery
| API | Description |
|---|---|
| StartRestore | Starts a backup-based recovery task. |
| RemoveBackupsSet | Deletes a specified backup set. |
| DescribeBackMenu | Checks whether a specified instance supports backup and recovery. |
| DescribeBackupTimes | Queries the point in time to which a specified instance can be restored. |
| DescribeRestoreOrder | Queries the current purchase order details for recovery. |
| DescribeBackupDbs | Queries the list of the databases that can be restored. |
| PutStartBackup | Submits a data backup task. |
| SetBackupPolicy | Specifies the backup policy. |
| EnableSqlFlashbackMatchSwitch | Runs the queries whose information is recorded in the binary log of ApsaraDB RDS for MySQL that serves as storage resources in a specified PolarDB-X 1.0 database for accurate data restoration. |
| DescribeBackupSets | Queries the information about backup sets. |
Network and connection
| API | Description |
|---|---|
| ReleaseInstanceInternetAddress | Releases the public endpoint of a specified instance to ensure instance security. |
| DescribeInstanceSwitchNetwork | Checks whether the network of a specified instance can be switched. |
| CreateInstanceInternetAddress | Creates a public IP address for a specified PolarDB-X 1.0 instance. |
| RefreshDrdsAtomUrl | Refreshes the connection to a PolarDB-X 1.0 database sharding to ensure the smooth connection from the sharding to an ApsaraDB RDS for MySQL instance after the connection to the instance is changed. The instance serves as storage resources. |
Task management
| API | Description |
|---|---|
| DescribeSqlFlashbakTask | Queries the list of flashback tasks. |
| DescribeDrdsInstanceLevelTasks | Queries the list of flashback tasks. |
| SubmitSqlFlashbackTask | Submits a Structured Query Language (SQL) flashback task. |
| DescribePreCheckResult | Queries the precheck result of a specified task. |
| DescribeDrdsTasks | Queries the change tasks for a specified instance. |
Table sharding
| API | Description |
|---|---|
| ValidateShardTask | Checks whether a sharding task is valid. |
| DescribeExpandLogicTableInfoList | Queries the shard key. |
| DatalinkReplicationPrecheck | Performs a precheck on a sharding task. |
| CreateShardTask | Creates a sharding task. |
| DescribeShardTaskInfo | Queries the details about a sharding task tool. |
| DeleteShardTasks | Deletes a sharding task. |
Data table management
| API | Description |
|---|---|
| DescribeTables | Retrieves the table information list. |
| DescribeTableListByType | Retrieves a collection of tables based on types. |
| DescribeTable | Queries the information about the table schema. |
| SetupTable | Specifies the full-table scan feature. |
Tag and parameter settings
| API | Description |
|---|---|
| TagResources | Attaches the tag to a specified instance. |
| UntagResources | Cancels the tag of a specified instance. |
| ListTagResources | Queries the tag of a specified instance. |
| DescribeDrdsParams | Queries the list of parameters for PolarDB-X 1.0. |
| SetupDrdsParams | Specifies the parameters for PolarDB-X 1.0. |
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 of a specified PolarDB-X 1.0 instance. |
| DescribeDrdsInstanceDbMonitor | Queries the performance monitoring data of a specified PolarDB-X 1.0 database. |
Others
| API | Description |
|---|---|
| DescribeDrdsDBIpWhiteList | Queries the IP address whitelist of a specified database. |
| ModifyDrdsIpWhiteList | Modifies the whitelist of a specified PolarDB-X 1.0 database. |
| DescribeInstanceSwitchAzone | Checks whether a specified instance supports zone switching. |
| DescribeDrdsSlowSqls | Queries the slow SQL of PolarDB-X 1.0. |