API 概覽 - PolarDB

API標準及多語言預置SDK

本產品（polardbx/2020-02-02）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

例項管理

API	標題	API概述
CreateDBInstance	Creation of an instance	Invoke the CreateDBInstance API to create a PolarDB-X instance.
DeleteDBInstance	刪除執行個體	呼叫DeleteDBInstance介面刪除執行個體。
DescribeDBInstanceAttribute	Query instance properties	You can invoke the DescribeDBInstanceAttribute API to obtain instance properties.
DescribeDBInstanceConfig	Query instance configuration parameters	Invoke the DescribeDBInstanceConfig API to retrieve instance configuration parameters.
DescribeDBInstances	Query database instance list	Invoke the DescribeDBInstances API to query the instance list.
DescribeDBInstanceSSL	View SSL information	View SSL information.
DescribeDBInstanceTDE	取得執行個體TDE的詳細資訊	呼叫DescribeDBInstanceTDE介面取得執行個體TDE的詳細資訊。
DescribeDBInstanceTopology	Query instance topology	Invoke the DescribeDBInstanceTopology API to obtain instance topology information.
DescribeDBInstanceViaEndpoint	Obtain instance information by connection address	Obtain basic information about an instance by using its connection address.
ModifyDBInstanceConfig	Modify instance configuration items	Invoke the ModifyDBInstanceConfig API to modify instance configuration items.
ModifyDBInstanceDescription	Modify instance description	You can invoke the ModifyDBInstanceDescription API to modify the instance description.
ReleaseInstancePublicConnection	Release the public endpoint of an instance	Invoke the ReleaseInstancePublicConnection API to release the public endpoint of an instance.
RestartDBInstance	Restart Instance	Invoke the RestartDBInstance API to restart the instance.
UpgradeDBInstanceKernelVersion	Upgrade Database Instance Kernel Version	Invoke the UpgradeDBInstanceKernelVersion API to update the kernel version of a database instance.
ModifyDBInstanceClass	Modify Instance Type	Invoke the ModifyDBInstanceClass API to modify the instance type.
UpdatePolarDBXInstanceNode	Update Nodes	Invoke the UpdatePolarDBXInstanceNode API to change the number of instance nodes, including scale-out and scale-in. This request generates a transaction order.
ChangeResourceGroup	Modify the resource group of an instance	Modify the resource group of an instance.
DescribeTransformStatus	Query Instance Upgrade Status	This API is primarily used to query the current status of a job that upgrades (or transforms) a Standard Edition instance to an Enterprise instance.
DescribePolarxDataNodes	View Data Node Information	This API is used to query detailed information about all data nodes in a PolarDB-X instance, including node status, storage usage, network addresses, and more, facilitating operations management and monitoring.
ModifyDBInstanceMaintainTime	Modify the maintenance window of an instance	Modify the maintenance window of an instance.
ModifyDBInstanceVip	Modify the virtual IP of an instance	This API is used to modify the virtual IP (Virtual IP) address bound to a database instance or its network properties. It supports operations such as changing the internal IP address, adjusting the subnet, and migrating zones.
DescribeRdsVpcs	Query the VPC list	API for querying the VPC list on PolarDB-X.
DescribeRdsVswitches	Query VSwitch List	This API is used to query the list of vSwitches in a virtual private cloud (VPC) available for an RDS instance.
DescribeShowStorageInfo	Query bucket information	Query the storage space usage details of an instance, including total capacity, used space, remaining space, and other information.
DescribeStoragePoolInfo	Query storage pool information	This API is used to query detailed information about storage pools, including capacity, usage, and status.
CreateStoragePool	Create storage pool	Create a resource storage pool
CreateCustomEndpoint	Create Custom Endpoint	This API is used to create a custom connection address (Endpoint) for a database instance.
DescribeCustomEndpointList	Query the custom domain name list	Query the list of user-defined domain names
ModifyCustomEndpointNet	Modify Custom Endpoint	This API is used to modify the network configuration of a custom endpoint, such as the subnet, security group, and public network access.
DeleteCustomEndpoint	Delete a custom endpoint	Delete a custom endpoint
ModifyCustomEndpoint	Modify Custom Endpoint	This API is used to modify the configuration of a custom cluster endpoint (Custom Endpoint).
ModifyDBInstanceConnectionString	Modify the instance connection string.	Modify the instance connection string.
AllocateInstancePublicConnection	Request a public endpoint	Invoke the AllocateInstancePublicConnection API to create a public IP address.
AllocateColdDataVolume	AllocateColdDataVolume	Invoke the AllocateColdDataVolume API.
ReleaseColdDataVolume	ReleaseColdDataVolume	Invoke the ReleaseColdDataVolume API.

監控與日誌

API	標題	API概述
DescribeSlowLogRecords	Query slow query log details	Supports querying slow SQL statement details from PolarDB-X compute nodes and data nodes.
DescribeDBNodePerformance	Query instance performance data	Invoke the DescribeDBNodePerformance API operation to query instance performance data.
DescribeSqlAuditInfo	View SQL Audit Information	This API is used to view SQL Audit information.
EnableSqlAudit	Enable SQL Audit	Enable the SQL Audit feature.
DisableSqlAudit	Disable SQL Audit	Disable the SQL Audit feature.
CheckSqlAuditSlsStatus	Validate Audit Status	This API is used to check whether the SQL audit logs of a specified database instance have been successfully connected to Simple Log Service (SLS), Alibaba Cloud's log service. After the API is invoked, the system returns the connection status between the SQL Audit feature of the current instance and SLS, along with configuration information such as the project and Logstore, and whether synchronization is operating normally.
DescribeEvents	Retrieve Historical Events	Retrieve historical management events.
DescribeActiveOperationMaintainConf	Display O&M time configuration	Invoke the DescribeActiveOperationMaintainConf API to display the O&M time configuration.
DescribeActiveOperationTasks	Retrieve O&M management events	Invoke the DescribeActiveOperationTasks API to obtain O&M events.
DescribeActiveOperationTaskCount	Obtain the total number of O&M events	Obtain the total number of O&M events.
ModifyActiveOperationMaintainConf	Modify O&M Event Time Configuration	Invoke the ModifyActiveOperationMaintainConf API to modify the O&M event time configuration.

任務管理

API	標題	API概述
DescribeTasks	Retrieve the instance job list	Retrieve the instance job list.
DescribeScaleOutMigrateTaskList	Display data migration job progress	Display the progress of a ScaleOut migration job.
CreateTransformOperation	Create Transformation Job	Create a transformation job to change the status or configuration of an instance.
DescribeRplInspectionTask	Obtain instance inspection jobs	This API is used to query the details of a replication delay inspection job for an instance.
SkipCurrentStep	Skip the current step	This API is used to skip the current step.
CreateRplInspectionTask	Replication Link Health Check	Used for health checks of the replication link during data migration.
CancelActiveOperationTasks	Cancel O&M Event Tasks	You can invoke the CancelActiveOperationTasks API to cancel O&M event tasks.
ModifyActiveOperationTasks	Modify the running time of O&M events	You can invoke the ModifyActiveOperationTasks API to modify the running time of O&M events.

SSL加密

API	標題	API概述
UpdateDBInstanceSSL	Update the SSL configuration of an instance	Update the SSL configuration of an instance.

引數管理

API	標題	API概述
ModifyParameter	Modify Instance Parameters	Invoke the ModifyParameter API to modify instance parameters, including those of the compute layer and the storage layer.
DescribeParameterTemplates	View parameter template details	You can invoke the DescribeParameterTemplates API to obtain the instance parameter template list.
DescribeParameters	Retrieve the parameter list	You can invoke the DescribeParameters API to obtain instance parameters.
DescribeParameterGroups	Query parameter group information	This API is used to query the list of database parameter groups created by the user or supported by the system, including basic information about each parameter group, associated engine type, updated time, and more.

備份管理

API	標題	API概述
CreateBackup	Creation of Backup	Invoke the CreateBackup API to create a backup.
DescribeBackupPolicy	Query instance backup settings	Invoke the DescribeBackupPolicy API to query instance backup settings.
DescribeBackupSetList	View Backup Set List	Invoke the DescribeBackupSetList API to view the backup set list.
DescribeBinaryLogList	Query binary logs	Invoke the DescribeBinaryLogList API to query binary logs.
UpdateBackupPolicy	Modify instance backup policy	You can invoke the UpdateBackupPolicy API to modify the backup policy of an instance.
DescribeOpenBackupSet	Obtain backup set information for on-premises recovery	Provides the instance topology and download link of commercial backup sets to meet the requirement of restoring cloud instances on-premises.
DescribeBackupSet	DescribeBackupSet	Invoke the DescribeBackupSet API to view the details of a backup set.

資料安全

API	標題	API概述
UpdateDBInstanceTDE	Enable TDE for an Instance	Invoke the UpdateDBInstanceTDE API to enable Transparent Data Encryption (TDE) for an instance.
ModifySecurityIps	Modify Instance Whitelist	Invoke the ModifySecurityIps API to modify the instance whitelist.
DescribeUserEncryptionKeyList	Obtain the list of user Transparent Data Encryption (TDE) keys	Invoke the DescribeUserEncryptionKeyList API to obtain the list of user Transparent Data Encryption (TDE) keys.
DescribeSecurityIps	View Instance Whitelist Information	Invoke the DescribeSecurityIps API to view the instance whitelist.
CheckCloudResourceAuthorized	KMS Key Authorization Validation	Invoke the CheckCloudResourceAuthorized API to query whether a PolarDB-X instance has been authorized to use the Key Management Service (KMS).
EnableRightsSeparation	EnableRightsSeparation	Enable three-role mode.
DisableRightsSeparation	DisableRightsSeparation	Disable three-role mode.

賬號管理

API	標題	API概述
ResetAccountPassword	ResetAccountPassword	Reset the account password.
CreateAccount	Create a standard account	Invoke the CreateAccount API to create an account.
CreateSuperAccount	Create a Privileged Account	Invoke the CreateSuperAccount API to create a privileged account. Each instance can have only one privileged account.
DeleteAccount	Delete an instance account	Invoke the DeleteAccount API to delete an account.
DescribeAccountList	Query instance account information	Invoke the DescribeAccountList API to obtain the account list.
ModifyAccountDescription	Modify the account description of an instance	You can invoke the ModifyAccountDescription API to modify the account description.
ResetAccountPasswordRestrict	Reset Account Password	Reset the account password.
ModifyAccountPrivilege	ModifyAccountPrivilege	Modify the permissions of a standard account.

地域

API	標題	API概述
DescribeRegions	View available regions and zones	Invoke the DescribeRegions API to obtain the Region List.
MigrateDBInstance	Instance Zone Migration	This API is used to migrate an instance from one zone to another.
DescribeAvailableCrossRegions	Query Cross-zone	This API is used to query the list of available zones that support cross-region operations, typically for multi-region deployment or data replication scenarios.
DescribeEnabledCrossRegions	Query enabled cross-zone configurations	This API is used to query the currently enabled cross-zone configurations.

資料庫管理

API	標題	API概述
CreateDB	Create Database	Invoke the CreateDB API to create a database.
DeleteDB	Delete Database	Invoke the DeleteDB API to delete a database.
DescribeCharacterSet	Query Character Sets	Invoke the DescribeCharacterSet API to query the character sets supported by the database of the target instance.
DescribeDbList	Query to obtain database information under an instance	Invoke the DescribeDbList API to obtain the database list.
DescribeDistributeTableList	Obtain the database table list	You can invoke the DescribeDistributeTableList API to obtain the database table list.
ModifyDatabaseDescription	Modify Database Description	You can invoke the ModifyDatabaseDescription API to modify the database description.
StartSwitchDatabase	Enable Database Switchover	This API is primarily used for database switchover during database migration or synchronization tasks.
DescribeComponentPropeties	Query widget properties	This API is used to obtain the property information of a specified widget, including the property name and type.
ModifyEngineMigration	Modify Engine Migration	ModifyEngineMigration

CDC管理

API	標題	API概述
UpgradeCDCVersion	Upgrade CDC Version	Upgrade the PolarDB-X CDC edge zone version
DescribeCdcInfo	Query CDC Instance Information	Query CDC information.
DescribeCdcVersionList	Retrieve CDC Versions	Obtain the CDC version list
DescribeCdcClassList	Instance Type List	Query the instance type list
ModifyCdcClass	Modify CDC configuration	Modify CDC configuration

列存管理

API	標題	API概述
AttachColumnarInstance	Mount Column Store	This API is used to mount a column store instance to a specified master database instance.
UpgradeColumnarVersion	Update column store version	Update column store version
ModifyColumnarClass	Modify column store specifications	Modify column store specifications
DescribeColumnarVersionList	Query column store version information	Query column store version information
DescribeColumnarInfo	Query column store information	Query column store information
DescribeColumnarClassList	Query the list of column store instance types	Query the list of column store instance types

資料遷移與同步

API	標題	API概述
DescribeEvaluateAndImportTask	Query the list of assessment import jobs	Query the list of PolarDB-X assessment import jobs. (Single job)
DescribeEvaluateAndImportTasks	Query the list of evaluation import jobs	Query the list of PolarDB-X assessment data import jobs. (Multiple)
DeleteEvaluateAndImportTask	Delete an evaluation import job	Delete an evaluation import job
CreateSQLEvaluateTask	SQL Assessment	Creates an SQL statement assessment job. Through this API, the user submits SQL statements, and the system performs static analysis and risk assessment to output execution risks and compatibility issues on the target database instance.
CreateStructureImportTask	Create a data structure import job	Creates a database structure import job. This API supports importing an SQL script file or text content that contains DDL statements into a target database instance, and automatically executes structured operations such as table creation, index creation, view creation, and stored procedure creation.
DescribeDataImportTaskInfo	Obtain Data Import Job Information	Query the execution details of a data import job.
CloseEngineMigration	Stop Engine Migration	This API is used to stop the database engine migration flow for a specified instance. After a user starts a data migration task from another database (such as self-managed MySQL or RDS) to PolarDB-X, this API can be used to safely stop the migration procedure if it needs to be terminated or its state cleaned up midway.
ConfirmNoConnection	Confirm that there are no active connections during rollback switching	Confirm that there are no active connections during rollback switching.
RestartDataImportTask	Restart a data import job	Restart a data import job.
StopDataImportTask	Stop a Data Import Job	This API is used to stop a data import job.
CreateDataImportTask	Create Data Import Task	Creates a data import job to import external data files (such as SQL scripts or CSV files) into a target database instance.
DescribeStructureImportTaskInfo	Query Data Import Job Information	This API is used to query the details of a database structure import job.
RefreshImportMeta	Purge Import Metadata	This API is used to purge the metadata of an import job.

GDN管理

API	標題	API概述
DeleteGdnInstance	Delete a GDN instance	Delete a GDN instance
DescribeGdnInstances	Obtain the GDN instance list information	Obtain the GDN instance list
SwitchGdnMemberRole	GDN primary/secondary failover	GDN primary/secondary failover.
CreateGdnInstance	Create a GDN instance	Create a GDN instance

SQL閃回

API	標題	API概述
SubmitSqlFlashbackTask	Create an SQL Flashback Job	Invoke the SubmitSqlFlashbackTask API to create an SQL flashback job.
PreCheckSqlFlashbackTask	SQL Flashback Recovery Check	This API is used to perform pre-checks and feasibility assessments for a flashback recovery job before executing SQL flashback recovery.
DescribeSqlFlashbackTaskList	View the list of SQL flashback jobs	Invoke the DescribeSqlFlashbackTaskList API to view the list of SQL flashback jobs.

標籤管理

API	標題	API概述
DescribeTags	Obtain tag information	Obtain tag information.
ListTagResources	Retrieve tag list	Obtain the tag list.
TagResources	Add tags to resources	Invoke the TagResources API to add tags to resources.
UntagResources	Remove tags from a resource	Remove tags from a resource.