API standards and multilingual preset SDKs
The OpenAPI of this product (Drds/2019-01-23) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Instance management
|
API |
Title |
Description |
| CreateDrdsInstance | Create an instance | Creates an instance. |
| CreateOrderForRds | Create an order to purchase an apsaraDB RDS instance | Creates an order to purchase an ApsaraDB RDS instance by calling the CreateOrderForRds operation. |
| ModifyDrdsInstanceDescription | Modify instance description | Modifies the description of a Distributed Relational Database Service (DRDS) instance. |
| UpdateResourceGroupAttribute | Transfer an instance to a new resource group | Calls the UpdateResourceGroupAttribute operation to transfer an instance to a new resource group. |
| DescribeDrdsInstances | Query DRDS instances | Queries a list of DRDS instances by calling the DescribeDrdsInstances operation. |
| DescribeDrdsDbInstance | Query RDS storage instance details | Queries the details of an ApsaraDB RDS storage instance for a DRDS instance. |
| DescribeDrdsInstance | Query DRDS instance details | Queries the details of a DRDS instance. |
| DescribeDrdsParams | Query DRDS parameter list | Invokes the DescribeDrdsParams operation to query the query parameter list. |
| DescribeDrdsTasks | Query instance change tasks | Queries the change tasks of an instance by calling the DescribeDrdsTasks operation. |
| DescribeHotDbList | Query the list of hot-spot scale-out databases | Calls the DescribeHotDbList operation to query the list of databases for hot-spot scale-out. |
| DescribeInstanceSwitchAzone | Check whether zone switching is available | Queries whether the zone can be switched by calling the DescribeInstanceSwitchAzone operation. |
| DescribeInstanceSwitchNetwork | Query whether an instance supports network transition | Queries whether an instance supports network transition by calling DescribeInstanceSwitchNetwork. |
| DescribeInstDbLogInfo | Query time range for importing historical SQL data | Queries the time range supported for importing historical SQL data into a database. |
| DescribePreCheckResult | View pre-check result | Calls the DescribePreCheckResult operation to view the pre-check result. |
| DescribeRdsCommodity | Query RDS sale-related data | Queries the sale-related data of the storage layer by calling the DescribeRdsCommodity operation. |
| RemoveDrdsInstance | Release a target instance | Calls the RemoveDrdsInstance operation to release a target instance. |
Database management
|
API |
Title |
Description |
| CreateDrdsDB | Create a database instance | Creates a DRDS database. |
| DescribeDrdsDBs | Query databases in an instance | Queries the details of databases in a specified instance by calling the DescribeDrdsDBs operation. |
| DescribeDrdsDB | View database details of an instance | Queries the details of a database in an instance by calling the DescribeDrdsDB operation. |
| DescribeDrdsDbInstances | Query RDS instances of a database | Queries the list of ApsaraDB RDS instances associated with a DRDS database. |
| DescribeDrdsDbRdsNameList | Query DRDS database storage instance list | Queries the list of storage instances by calling the DescribeDrdsDbRdsNameList operation. |
| DescribeDrdsShardingDbs | Query horizontally sharded databases under DRDS | Queries horizontally sharded databases under a PolarDB-X instance by calling the DescribeDrdsShardingDbs operation. |
| CheckDrdsDbName | Check whether a DRDS database name is valid | Checks whether a DRDS database name is valid. |
| RemoveDrdsDbFailedRecord | Delete a failed database creation record | Calls the RemoveDrdsDbFailedRecord operation to delete a failed database creation record. |
| RemoveDrdsDb | Delete a database | Deletes a database from a DRDS instance. |
Storage management
|
API |
Title |
Description |
| ModifyRdsReadWeight | Modify read and write weights of an apsaraDB RDS instance | Modifies the read and write weights of an ApsaraDB RDS instance by calling the ModifyRdsReadWeight operation. |
| DescribeRdsPerformanceSummary | Query RDS performance details such as CPU | Queries the performance details (such as CPU) of ApsaraDB RDS instances by calling the DescribeRdsPerformanceSummary operation. |
| DescribeRdsSuperAccountInstances | Retrieve RDS privileged accounts | Calls DescribeRdsSuperAccountInstances to retrieve the privileged accounts of ApsaraDB RDS instances. |
| DescribeDrdsDBCluster | Query polarDB cluster details in a logical database | Queries the details of a PolarDB cluster in a DRDS logical database. |
| DescribeRDSPerformance | Query storage-layer RDS performance data | Queries the performance data of an ApsaraDB RDS instance at the storage layer by calling the DescribeRDSPerformance operation. |
| DescribeDbInstances | View storage-layer instance list | Queries the list of storage-layer instances, such as ApsaraDB RDS or PolarDB instances. |
| DescribeDbInstanceDbs | Query databases under a target storage instance | Queries the list of databases under a target storage instance by calling the DescribeDbInstanceDbs operation. |
Account management
|
API |
Title |
Description |
| CreateInstanceAccount | Create a DRDS instance-level account | Creates an instance-level account for a DRDS instance by calling the CreateInstanceAccount operation. |
| RemoveInstanceAccount | Delete an Instance Management Account | Calls the RemoveInstanceAccount operation to delete an instance management account. |
SQL audit
|
API |
Title |
Description |
| EnableSqlAudit | Enable SQL audit | Enables the SQL audit feature by calling the EnableSqlAudit operation. |
| DisableSqlAudit | Cancel SQL audit | Calls the DisableSqlAudit operation to cancel SQL audit. |
| DescribeDrdsSqlAuditStatus | Query DRDS SQL audit information | Queries the SQL audit information of a DRDS instance by calling the DescribeDrdsSqlAuditStatus operation. |
| DescribeInstDbSlsInfo | Query SLS project and logstore names | Queries the names of the SLS project and Logstore used for SQL audit. |
| DescribeDrdsSlowSqls | View slow SQL statements | Queries slow SQL statements of a DRDS instance. |
| CheckSqlAuditEnableStatus | Check whether SQL audit is enabled for a DRDS logical database | Checks whether SQL audit is enabled for a DRDS logical database by calling the CheckSqlAuditEnableStatus operation. |
Backup and recovery
|
API |
Title |
Description |
| StartRestore | Start a backup-based restoration task | Starts a backup-based restoration task by calling the StartRestore operation. |
| SetBackupPolicy | Set backup policy | Sets a backup policy. |
| EnableSqlFlashbackMatchSwitch | Precisely restore data with SQL flashback | At this point, the BINLOG of the ApsaraDB RDS instance used by the DRDS database includes the information about executed queries. |
| DescribeBackMenu | Query whether an instance supports backup and recovery | Queries whether an instance supports backup and recovery by calling the DescribeBackMenu operation. |
| DescribeRestoreOrder | View restoration purchase order details | Queries the order details of the current restoration purchase. |
| DescribeBackupDbs | Query restorable databases | Queries the list of databases that can be restored by calling the DescribeBackupDbs operation. |
| DescribeBackupSets | Query backup set information | Calls the DescribeBackupSets operation to query backup set information. |
| DescribeBackupPolicy | Query the Automatic Backup Policy of a Cluster | Queries the details of a backup policy by calling the DescribeBackupPolicy operation. |
| DescribeBackupTimes | Query restorable time of an instance | Queries the target time to which an instance can be restored by calling the DescribeBackupTimes operation. |
| RemoveBackupsSet | Delete a backup set | Calls the RemoveBackupsSet operation to delete a backup set. |
| PutStartBackup | Submit a data backup task | Submits a data backup task by calling the PutStartBackup operation. |
Network and connectivity
|
API |
Title |
Description |
| CreateInstanceInternetAddress | Create a public IP address for a DRDS instance | Creates a public IP address for a Distributed Relational Database Service (DRDS) instance by calling the CreateInstanceInternetAddress operation. |
| UpdateInstanceNetwork | Switch the network type of a DRDS instance | Switches the network type of a DRDS instance by calling the UpdateInstanceNetwork operation. |
| ReleaseInstanceInternetAddress | Release the public endpoint of an instance | Ensures instance security. |
Security
|
API |
Title |
Description |
| ModifyDrdsIpWhiteList | Modify database IP whitelist | Calls the ModifyDrdsIpWhiteList operation to modify the IP whitelist of a database. |
| DescribeDrdsDBIpWhiteList | Query IP whitelist | Queries the IP whitelist of a specified database. |
Scaling management
|
API |
Title |
Description |
| SubmitCleanTask | Submit a cleanup task for a scaling operation | Submits a cleanup task for a scaling operation by calling the SubmitCleanTask operation. |
| SubmitSmoothExpandPreCheck | Submit a smooth scale-out precheck task | Submits a smooth scale-out precheck task by calling the SubmitSmoothExpandPreCheck operation. |
| CheckExpandStatus | Check whether a database supports scaling operations | Checks whether a DRDS database supports scaling operations such as smooth scale-out. |
| SubmitHotExpandTask | Submit a hotspot scale-out task | Calls the SubmitHotExpandTask operation to submit a hotspot scale-out task. |
| SubmitHotExpandPreCheckTask | Submit a hotspot scaling dry run task | Performs checks that mainly include checking for table without primary key. |
Task management
|
API |
Title |
Description |
| DescribeSqlFlashbakTask | Query flashback tasks | Queries the list of flashback tasks. |
| SubmitSqlFlashbackTask | Submit an SQL flashback task | Calls the SubmitSqlFlashbackTask operation to submit an SQL flashback task. |
Table sharding
|
API |
Title |
Description |
| CreateShardTask | Create a sharding task | Calls the CreateShardTask operation to create a sharding task. |
| DescribeInstanceAccounts | View instance account information | Queries the account information of an instance by calling the DescribeInstanceAccounts operation. |
| DescribeExpandLogicTableInfoList | Query logical table shard keys | Calls the DescribeExpandLogicTableInfoList operation to query shard keys. |
| DescribeTable | Retrieve table schema information | Queries table schema information by calling the DescribeTable operation. |
| DescribeTableListByType | Query tables by type | Queries a collection of tables by type by calling the DescribeTableListByType operation. |
| DescribeShardTaskInfo | Query shard change tool details | Queries the details of the shard change tool by calling DescribeShardTaskInfo. |
| ValidateShardTask | Check whether a sharding change task is valid | Calls the ValidateShardTask operation to check whether a sharding change task is valid. |
Broadcast table
|
API |
Title |
Description |
| SetupBroadcastTables | Set up broadcast tables | Calls the SetupBroadcastTables operation to set up broadcast tables. |
| DescribeBroadcastTables | Query broadcast tables | Queries broadcast tables by calling the DescribeBroadcastTables operation. |
| SwitchGlobalBroadcastType | Switch a broadcast table from multi-write to asynchronous link mode | Switches a broadcast table from multi-write mode to asynchronous link mode by calling the SwitchGlobalBroadcastType operation. |
Data table management
|
API |
Title |
Description |
| SetupTable | Enable full table scan | Calls the SetupTable operation to enable full table scan. |
| DescribeTables | Retrieve table information list | Calls the DescribeTables operation to retrieve a list of table information. |
Tags and parameter settings
|
API |
Title |
Description |
| SetupDrdsParams | Configure instance parameters | Configures the parameters of an instance by calling the SetupDrdsParams operation. |
| ListTagResources | Query labels bound to resources | Queries the labels bound to resources by calling ListTagResources. |
| TagResources | Add labels to resources | Calls the TagResources operation to add labels to resources. |
| UntagResources | Remove tags from resources | Calls the UntagResources operation to remove tags from resources. |
Instance version
|
API |
Title |
Description |
| DescribeDrdsInstanceVersion | View instance version | Queries the version of a DRDS instance. |
| DescribeDrdsInstanceLevelTasks | Query incomplete tasks of a DRDS instance | Queries incomplete tasks in a DRDS instance by calling the DescribeDrdsInstanceLevelTasks operation. |
| UpgradeInstanceVersion | Upgrade the version of a DRDS instance | Upgrades the version of a DRDS instance. |
Performance monitoring
|
API |
Title |
Description |
| DescribeDrdsInstanceMonitor | Query instance monitoring data | Invokes the DescribeDrdsInstanceMonitor operation to query the details of instance monitoring data. |
| DescribeDrdsInstanceDbMonitor | Query performance monitoring data of a database | Calls the DescribeDrdsInstanceDbMonitor operation to query performance monitoring data of a database. |
Others
|
API |
Title |
Description |
| ChangeAccountPassword | Reset DRDS database password | Resets the password of a DRDS database by calling the ChangeAccountPassword operation. |
| ChangeInstanceAzone | Switch instance zone | Switches the zone of a DRDS instance. |
| DescribeBackupLocal | Query local backup sets | Calls the DescribeBackupLocal operation to query binary log settings. |
| DescribeDrdsRdsInstances | Private custom RDS instance details | Queries the details of all private custom ApsaraDB RDS instances under a specified PolarDB-X instance. |
| DescribeRecycleBinStatus | Query table recycle bin status | Queries the status of the table recycle bin by calling the DescribeRecycleBinStatus operation. |
| DescribeRecycleBinTables | Query recyclable tables | Queries the recyclable tables. |
| EnableInstanceIpv6Address | Create an iPv6 address | Calls the EnableInstanceIpv6Address operation to create an IPv6 address. |
| FlashbackRecycleBinTable | FlashbackRecycleBinTable | Restores a deleted logical table. |
| GetDrdsDbRdsRelationInfo | Query database storage instance structure | Calls the GetDrdsDbRdsRelationInfo operation to query the storage instance structure of a database. |
| ManagePrivateRds | Manage private RDS instances | Calls the ManagePrivateRds operation to manage private custom RDS instances in the storage layer. |
| ModifyAccountDescription | Modify account description | Calls the ModifyAccountDescription operation to modify the description of an account. |
| ModifyAccountPrivilege | Modify account permissions | Modifies the permissions of an account. |
| ModifyPolarDbReadWeight | Modify read and write weights of polarDB | Modifies the read and write weights of a PolarDB cluster by calling the ModifyPolarDbReadWeight operation. |
| RefreshDrdsAtomUrl | Refresh DRDS shard connections | After an RDS connection changes, refreshes the DRDS shard connections to ensure connectivity to RDS. |
| RemoveRecycleBinTable | Purge a table from the recycle bin | Purges a table from the recycle bin. |
| RestartDrdsInstance | Restart an instance | Restarts a Distributed Relational Database Service (DRDS) instance. |
| RollbackInstanceVersion | Roll back the version of a DRDS instance | Rolls back the version of a DRDS instance. |
| SetBackupLocal | Set local backup set policy | Modifies the backup policy. |
| SetupRecycleBinStatus | Enable table recycle bin | Calls the SetupRecycleBinStatus operation to enable the table recycle bin. |
| SubmitSmoothExpandPreCheckTask | Submit a smooth scale-out dry run task | Submits a dry run task for smooth scale-out. |
| UpdatePrivateRdsClass | Upgrade or downgrade a storage-layer custom RDS instance | Upgrades or downgrades the specifications of a storage-layer custom ApsaraDB RDS instance. |
| UpgradeHiStoreInstance | Upgrade a histore instance | Upgrades the version of a DRDS column-oriented calculation instance. |