API overview - PolarDB - Alibaba Cloud Documentation Center

API standards and multilingual preset SDKs

The OpenAPI of this product (polardbx/2020-02-02) 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.

实例管理

API	Title	Description
CreateDBInstance	Create Instance	Calls the CreateDBInstance operation to create a PolarDB-X instance.
DeleteDBInstance	Delete an instance	Calls the DeleteDBInstance operation to delete an instance.
DescribeDBInstanceAttribute	Query instance attributes	Calls the DescribeDBInstanceAttribute operation to retrieve instance attributes.
DescribeDBInstanceConfig	Query instance configuration parameters	Calls the DescribeDBInstanceConfig operation to retrieve the configuration parameters of an instance.
DescribeDBInstances	Query database instance list	Calls the DescribeDBInstances operation to query a list of instances.
DescribeDBInstanceSSL	View SSL Information	Views SSL information.
DescribeDBInstanceTDE	Query TDE details of an instance	Calls the DescribeDBInstanceTDE operation to retrieve the details of Transparent Data Encryption (TDE) for an instance.
DescribeDBInstanceTopology	Query instance topology information	Calls the DescribeDBInstanceTopology operation to retrieve the topology information of an instance.
DescribeDBInstanceViaEndpoint	Retrieve instance information by endpoint	Retrieves the basic information about an instance by using the endpoint of the instance.
ModifyDBInstanceConfig	Modify instance configuration items	Calls the ModifyDBInstanceConfig operation to modify instance configuration items.
ModifyDBInstanceDescription	Modify instance description	Calls the ModifyDBInstanceDescription operation to modify the description of an instance.
ReleaseInstancePublicConnection	Release the public endpoint of an instance	Releases the public network connection of an instance by calling the ReleaseInstancePublicConnection operation.
RestartDBInstance	Restart an instance	Restarts an instance by calling the RestartDBInstance operation.
UpgradeDBInstanceKernelVersion	Upgrade database instance kernel version	Invokes the UpgradeDBInstanceKernelVersion operation to update the kernel version of an instance.
ModifyDBInstanceClass	Modify instance specifications	Modifies the specifications of an instance by calling the ModifyDBInstanceClass operation.
UpdatePolarDBXInstanceNode	Update nodes	Calls the UpdatePolarDBXInstanceNode operation to change the number of nodes for an instance, including scaling out and scaling in. This request generates a billable order.
ChangeResourceGroup	Modify instance resource group	Modifies the resource group of an instance.
DescribeTransformStatus	Query instance upgrade status	Queries the current status of a task that upgrades or converts a standard instance to an Enterprise instance.
DescribePolarxDataNodes	View data node information	Queries the details of all data nodes (Data Nodes) in a PolarDB-X instance, including node status, storage usage, and network addresses, to facilitate operations management and monitoring.
ModifyDBInstanceMaintainTime	Modify instance maintenance window	Modifies the maintenance window of an instance.
ModifyDBInstanceVip	Modify instance virtual IP	Modifies the virtual IP (VIP) address or network properties bound to a database instance. This operation supports changing the internal IP address, adjusting the vSwitch, migrating across zones, and other operations.
DescribeRdsVpcs	Query VPC list	Queries the list of VPCs available for PolarDB-X.
DescribeRdsVswitches	Query vSwitch list	Queries the list of available vSwitches in a virtual private cloud (VPC) for an ApsaraDB RDS instance.
DescribeShowStorageInfo	Query storage space information	Queries the storage usage details of an instance, including the total capacity, used space, remaining space, and other information.
DescribeStoragePoolInfo	Query storage pool information	Queries the details of a storage pool, including capacity, usage, and status.
CreateStoragePool	Create a storage pool	Creates a resource storage pool.
CreateCustomEndpoint	Create a custom endpoint	Creates a custom endpoint for a database instance.
DescribeCustomEndpointList	Query custom endpoint list	Queries the list of custom endpoints defined by the user.
ModifyCustomEndpointNet	Modify a custom network endpoint	Modifies the network configurations of a custom network endpoint, such as the subnet, security group, and public network access settings.
DeleteCustomEndpoint	Delete a custom endpoint domain name	Deletes a custom endpoint domain name.
ModifyCustomEndpoint	Modify custom endpoint	Modifies the configuration of a custom endpoint.
ModifyDBInstanceConnectionString	Modify instance connection string	Modifies the connection string of an instance.
AllocateInstancePublicConnection	Apply for a public endpoint	Calls the AllocateInstancePublicConnection operation to create a public IP address.
AllocateColdDataVolume	AllocateColdDataVolume	Calls the AllocateColdDataVolume operation.
ReleaseColdDataVolume	ReleaseColdDataVolume	Calls the ReleaseColdDataVolume operation.

监控与日志

API	Title	Description
DescribeSlowLogRecords	Query slow log details	Queries the details of slow SQL statements on compute nodes and storage nodes of a PolarDB-X instance.
DescribeDBNodePerformance	Query instance performance data	Queries the performance data of an instance by calling the DescribeDBNodePerformance operation.
DescribeSqlAuditInfo	Query SQL audit information	Queries SQL audit information.
EnableSqlAudit	Enable SQL Audit	Enables the SQL audit feature.
DisableSqlAudit	Disable SQL audit	Disables the SQL audit feature.
CheckSqlAuditSlsStatus	Check audit status	Checks whether SQL audit logs of a specified database instance have been successfully connected to Simple Log Service (SLS). After the call, the system returns the connection status between the SQL audit feature and SLS for the current instance, the project and Logstore configuration information, and whether synchronization is normal.
DescribeEvents	Retrieve historical events	Retrieves historical events.
DescribeActiveOperationMaintainConf	Display O&M window configuration	Calls the DescribeActiveOperationMaintainConf operation to display the O&M window configuration.
DescribeActiveOperationTasks	Query O&M events	Queries O&M events by calling the DescribeActiveOperationTasks operation.
DescribeActiveOperationTaskCount	Retrieve the total number of O&M events	Retrieves the total number of O&M events.
ModifyActiveOperationMaintainConf	Modify O&M event time configuration	Calls the ModifyActiveOperationMaintainConf operation to modify the time configuration of O&M events.

任务管理

API	Title	Description
DescribeTasks	Retrieve instance task list	Retrieves the task list of an instance.
DescribeScaleOutMigrateTaskList	Display data migration task progress	Display the ScaleOut migration task progress.
CreateTransformOperation	Create a conversion task	Creates a conversion task to change a specific status or configuration of an instance.
DescribeRplInspectionTask	Get instance inspection task	Queries the details of a replication lag inspection task for an instance.
SkipCurrentStep	SkipCurrentStep	This API is used to skip the current step.
CreateRplInspectionTask	Replication task health check	Performs a health check on the replication task during data migration.
CancelActiveOperationTasks	Cancel active O&M event tasks	Cancels active O&M event tasks by calling the CancelActiveOperationTasks operation.
ModifyActiveOperationTasks	Modify O&M event execution time	Calls the ModifyActiveOperationTasks operation to modify the execution time of O&M events.

SSL加密

API	Title	Description
UpdateDBInstanceSSL	Update instance SSL configuration	Updates the SSL configuration of an instance.

参数管理

API	Title	Description
ModifyParameter	Modify instance parameters	Calls the ModifyParameter operation to modify instance parameters, including compute layer and storage layer parameters.
DescribeParameterTemplates	View parameter template details	Calls the DescribeParameterTemplates operation to retrieve the parameter template list for an instance.
DescribeParameters	Retrieve parameter list	Calls the DescribeParameters operation to retrieve instance parameters.
DescribeParameterGroups	Query parameter template information	Queries the list of database parameter templates created by users or supported by the system, including basic information, associated engine types, and modification times of each parameter template.

备份管理

API	Title	Description
CreateBackup	Create a backup	Calls the CreateBackup operation to create a backup.
DescribeBackupPolicy	Query instance backup settings	Calls the DescribeBackupPolicy operation to query the backup settings of an instance.
DescribeBackupSetList	Query backup set list	Calls the DescribeBackupSetList operation to query the list of backup sets.
DescribeBinaryLogList	Query Binlog Logs	Calls the DescribeBinaryLogList operation to query binlog logs.
UpdateBackupPolicy	Modify instance backup policy	Calls the UpdateBackupPolicy operation to modify the backup policy of an instance.
DescribeOpenBackupSet	Retrieve backup set information for offline restoration	Exposes instance topology information and download links for commercial backup sets to support offline restoration of cloud instances.
DescribeBackupSet	DescribeBackupSet	Queries the details of a backup set by calling the DescribeBackupSet operation.

数据安全

API	Title	Description
UpdateDBInstanceTDE	Enable instance TDE	Enables Transparent Data Encryption (TDE) for an instance by calling the UpdateDBInstanceTDE operation.
ModifySecurityIps	Modify instance whitelist	Calls the ModifySecurityIps operation to modify the whitelist of an instance.
DescribeUserEncryptionKeyList	Retrieve user TDE key list	Calls the DescribeUserEncryptionKeyList operation to retrieve the list of Transparent Data Encryption (TDE) keys for a user.
DescribeSecurityIps	View instance IP whitelist information	Calls the DescribeSecurityIps operation to view the IP whitelist of an instance.
CheckCloudResourceAuthorized	Check KMS key authorization	Checks whether a PolarDB-X instance is authorized to use Key Management Service (KMS).
EnableRightsSeparation	EnableRightsSeparation	Enables three-role mode.
DisableRightsSeparation	DisableRightsSeparation	Disables three-role mode.

账号管理

API	Title	Description
ResetAccountPassword	ResetAccountPassword	Resets the password of an account.
CreateAccount	Create a standard account	Creates an account by calling the CreateAccount operation.
CreateSuperAccount	Create a privileged user	Creates a privileged user. Each instance can have only one privileged user.
DeleteAccount	Delete an instance account	Deletes an account by calling the DeleteAccount operation.
DescribeAccountList	Query instance account information	Queries the list of accounts by calling the DescribeAccountList operation.
ModifyAccountDescription	Modify the account description of an instance	Calls the ModifyAccountDescription operation to modify the description of an account.
ResetAccountPasswordRestrict	Reset account password	Resets the password of an account.
ModifyAccountPrivilege	ModifyAccountPrivilege	Modifies the permissions of a standard account.

地域

API	Title	Description
DescribeRegions	View available regions and zones	Calls the DescribeRegions operation to obtain the list of regions.
MigrateDBInstance	Migrate instance across zones	Migrates an instance from one zone to another.
DescribeAvailableCrossRegions	Query cross-zone regions	Queries the list of available regions that support cross-region operations, typically used for multi-region deployment or data replication scenarios.
DescribeEnabledCrossRegions	Query enabled cross-zone configurations	Queries the currently enabled cross-zone configurations.

数据库管理

API	Title	Description
CreateDB	Create a database	Creates a database by calling the CreateDB operation.
DeleteDB	Delete a database	Deletes a database by calling the DeleteDB operation.
DescribeCharacterSet	Query character sets	Invokes the DescribeCharacterSet operation to query the character set types supported by databases in a target instance.
DescribeDbList	Query databases of an instance	Queries the list of databases by calling the DescribeDbList operation.
DescribeDistributeTableList	Retrieve database table list	Calls the DescribeDistributeTableList operation to retrieve the list of database tables.
ModifyDatabaseDescription	Modify database description	Calls the ModifyDatabaseDescription operation to modify the description of a database.
StartSwitchDatabase	Start database cutover	Starts a database cutover for a database migration or synchronization task.
DescribeComponentPropeties	Query component properties	Retrieves the property information of a specified component, including property names and types.
ModifyEngineMigration	Modify engine migration	Modifies the configuration or migration parameters of a database engine migration task, such as the source database, destination database, migration objects, or migration mode.

CDC管理

API	Title	Description
UpgradeCDCVersion	Upgrade CDC version	Upgrades the CDC node version of a PolarDB-X instance.
DescribeCdcInfo	Query CDC instance information	Queries CDC information.
DescribeCdcVersionList	Retrieve CDC versions	Retrieves the list of CDC versions.
DescribeCdcClassList	List instance specifications	Queries the list of instance specifications.
ModifyCdcClass	Modify CDC configuration	Modifies the CDC configuration.

列存管理

API	Title	Description
AttachColumnarInstance	Mount column store	Mounts a columnar instance to a specified primary database instance.
UpgradeColumnarVersion	Update column store version	Updates the column store version.
ModifyColumnarClass	Modify column store specifications	Modifies the column store specifications.
DescribeColumnarVersionList	Query column store version information	Query column store version information
DescribeColumnarInfo	Query column store information	Queries column store information.
DescribeColumnarClassList	Query column store specifications	Queries the list of column store specifications for an instance.

数据迁移与同步

API	Title	Description
DescribeEvaluateAndImportTask	Query assessment import task list	Queries the list of PolarDB-X assessment import tasks. (Single).
DescribeEvaluateAndImportTasks	Query assessment import task list	Queries a list of assessment import tasks for PolarDB-X.
DeleteEvaluateAndImportTask	Delete an evaluation import task	Deletes an evaluation import task.
CreateSQLEvaluateTask	SQL assessment	Creates a SQL statement assessment task. You submit SQL statements through this operation, and the system performs static analysis and risk assessment to identify execution risks and compatibility issues on the target database instance.
CreateStructureImportTask	Create a database schema import task	Creates a database schema import task. This operation allows you to import SQL script files or text content that contains DDL statements into a target database instance, and automatically performs schema operations such as creating tables, indexes, views, and stored procedures.
DescribeDataImportTaskInfo	Get data import task information	Queries the execution details of a data import task.
CloseEngineMigration	Close engine migration	Closes the database engine migration process for a specified instance. After you start a data migration task from another database (such as a self-managed MySQL database or an ApsaraDB RDS instance) to PolarDB-X, you can call this operation to safely stop the migration process if you need to terminate or clean up the migration state.
ConfirmNoConnection	Confirm no connections during rollback switchover	Confirms that no active connections exist before performing a rollback switchover.
RestartDataImportTask	Restart a data import task	Restarts a data import task.
StopDataImportTask	Stop a data import task	Stops a data import task.
CreateDataImportTask	Create a data import task	Creates a data import task to import external data files, such as SQL scripts and CSV files, into a target database instance.
DescribeStructureImportTaskInfo	Query data import task information	Queries the details of a database schema import task.
RefreshImportMeta	Refresh import metadata	Refreshes the metadata of an import task.

GDN管理

API	Title	Description
DeleteGdnInstance	Delete a GDN instance	Deletes a global database network (GDN) instance.
DescribeGdnInstances	Retrieve GDN instance list	Retrieves a list of global database network (GDN) instances.
SwitchGdnMemberRole	GDN primary/secondary switchover	Performs a primary/secondary switchover for a global database network (GDN).
CreateGdnInstance	Create a GDN instance	Creates a Global Database Network (GDN) instance.

SQL闪回

API	Title	Description
SubmitSqlFlashbackTask	Create a SQL flashback task	Creates a SQL flashback task by calling the SubmitSqlFlashbackTask operation.
PreCheckSqlFlashbackTask	SQL flashback recovery check	Performs a pre-check and feasibility assessment for a recovery task before you execute SQL flashback recovery.
DescribeSqlFlashbackTaskList	Query SQL flashback tasks	Queries the list of SQL flashback tasks by calling the DescribeSqlFlashbackTaskList operation.

标签管理

API	Title	Description
DescribeTags	Retrieve tag information	Retrieves tag information.
ListTagResources	Retrieve label list	Retrieves a list of labels.
TagResources	Add tags to resources	Calls the TagResources operation to add tags to resources.
UntagResources	Remove tags from a resource	Removes tags from a resource.

其他

API	Title	Description
CreateMem0	Enable Memory Engine	Create mem0
DeleteMem0	Shut down memory engine	Delete mem0
DescribeMem0Info	View DPI engine information	Query mem0 instance information