API概览

云原生关系型数据库PolarDB提供以下相关API接口。

地域

API	描述
DescribeRegions	该接口用于查询PolarDB支持的地域和可用区。

集群

类别	API	描述
集群管理	CreateDBCluster	该接口用于创建PolarDB集群。
	DeleteDBCluster	该接口用于释放按量付费的PolarDB集群。
	DescribeDBClusters	该接口用于查询PolarDB集群列表或被RAM授权的集群列表。
	DescribeDBClusterAttribute	该接口用于查询指定PolarDB集群的详细属性。
	ModifyDBClusterMaintainTime	该接口用于修改PolarDB集群可例行维护的时间，一般设置为业务的低峰时间段。阿里云会在您设置的可维护时间段内进行集群维护，保证对业务的影响降到最小。
	ModifyDBClusterDescription	该接口用于修改PolarDB集群名称，方便集群的维护。
	DescribeTasks	该接口用于查看通过API生成的任务（如创建集群）进度详情。
部署架构	ModifyDBClusterPrimaryZone	该接口用于变更PolarDB集群的主可用区。
	FailoverDBCluster	该接口用于手动对PolarDB集群进行主备切换，可以指定一个只读节点为新的主节点。
	DescribeGlobalDatabaseNetworks	该接口用于查看账号下所有全球数据库网络（GDN）的详情。
续费管理	DescribeAutoRenewAttribute	该接口用于查询PolarDB包年包月集群自动续费状态。
	ModifyAutoRenewAttribute	该接口用于设置PolarDB包年包月集群自动续费状态。
	DescribeDBClusterAvailableResources	该接口用于查询PolarDB集群可售卖资源。

内核

API	描述
DescribeDBClusterVersion	该接口用于查看PolarDB MySQL引擎集群当前内核版本的详细信息。
UpgradeDBClusterVersion	该接口用于升级PolarDB MySQL引擎集群当前的内核版本。

数据安全

类别	API	描述
白名单	ModifyDBClusterAccessWhitelist	该接口用于创建或修改PolarDB集群的白名单（包括IP白名单和安全组）。
	DescribeDBClusterAccessWhitelist	该接口用于查询允许访问PolarDB集群的IP白名单和安全组。
SSL加密	ModifyDBClusterSSL	该接口用于设置PolarDB集群SSL加密的开通、关闭或更新CA证书。
	DescribeDBClusterSSL	该接口用于查询PolarDB集群SSL设置。
TDE加密	DescribeDBClusterTDE	该接口用于查询PolarDB集群的TDE设置详情。
	ModifyDBClusterTDE	该接口用于开启PolarDB MySQL引擎集群的TDE功能或修改加密方式。

节点

API	描述
CreateDBNodes	该接口用于增加PolarDB集群的只读节点。
ModifyDBNodeClass	该接口用于变更PolarDB集群节点规格。
RestartDBNode	该接口用于重启PolarDB集群节点。
DeleteDBNodes	该接口用于删除PolarDB集群节点。

集群参数

API	描述
DescribeDBClusterParameters	该接口用于查询PolarDB集群的参数。
ModifyDBClusterParameters	该接口用于修改PolarDB集群的参数。

访问地址

API	描述
CreateDBEndpointAddress	该接口用于创建PolarDB集群的公网地址，包括主地址、默认集群地址和自定义集群地址的公网地址。
CreateDBClusterEndpoint	该接口用于创建PolarDB自定义集群地址。
DescribeDBClusterEndpoints	该接口用于查询PolarDB集群的地址信息。
ModifyDBClusterEndpoint	该接口用于修改PolarDB的集群地址属性，包括读写模式、新节点是否自动加入本地址、一致性级别等。
ModifyDBEndpointAddress	该接口用于修改PolarDB集群公网地址，包括主地址、默认集群地址和自定义集群地址的公网地址。
DeleteDBEndpointAddress	该接口用于释放PolarDB集群的公网地址，包括主地址的公网链接、集群地址的公网链接以及自定义的集群地址的公网链接。
DeleteDBClusterEndpoint	该接口用于释放PolarDB自定义集群地址。

日志

API	描述
DescribeSlowLogRecords	该接口用于查询PolarDB集群的慢日志明细。
DescribeDBClusterAuditLogCollector	该接口用于查询PolarDB集群的SQL采集功能是否开启，SQL采集包括审计日志、SQL洞察等功能。
ModifyDBClusterAuditLogCollector	该接口用于开启或关闭PolarDB集群的SQL采集功能，SQL采集包括审计日志、SQL洞察等功能。

账号

API	描述
CreateAccount	该接口用于为PolarDB数据库创建账号。
DescribeAccounts	该接口用于查询PolarDB集群的数据库账号信息。
CheckAccountName	该接口用于校验账号名称是否合法或当前集群中是否已存在重名的账号。
ModifyAccountDescription	该接口用于修改PolarDB数据库账号的备注信息。
ModifyAccountPassword	该接口用于修改PolarDB数据库的账号密码。
GrantAccountPrivilege	该接口用于授权普通账号访问PolarDB集群的某个数据库，一个账号可关联一个或多个数据库。
RevokeAccountPrivilege	该接口用于移除PolarDB普通账号对数据库的访问权限。
ResetAccount	该接口用于重置PolarDB高权限账号。
DeleteAccount	该接口用于删除PolarDB数据库账号。

数据库

API	描述
CreateDatabase	该接口用于在PolarDB集群下创建一个新的数据库。
DescribeDatabases	该接口用于查询PolarDB指定集群的数据库列表信息。
ModifyDBDescription	该接口用于修改PolarDB数据库的描述或备注信息。
DeleteDatabase	该接口用于删除PolarDB集群下的数据库。
DescribeCharacterSetName	该接口用于查看PolarDB MySQL引擎数据库支持的字符集列表。
CheckDBName	该接口用于校验数据库名称是否合法或当前集群中是否已存在重名的数据库名称。

备份

类别	API	描述
备份管理	CreateBackup	该接口用于手动为PolarDB集群创建全量快照备份。
	DescribeBackups	该接口用于查询PolarDB集群的备份信息。
	DescribeBackupTasks	该接口用于查询PolarDB集群的备份任务列表。
	DescribeBackupLogs	该接口用于查询备份日志列表、获取备份日志下载地址。
	DescribeDetachedBackups	该接口用于查询已被释放的PolarDB集群中备份集的信息。
	DescribeDBClustersWithBackups	该接口用于查询某地域下包含备份集的PolarDB集群详情。
	DeleteBackup	该接口用于删除PolarDB集群的备份。
备份策略	DescribeBackupPolicy	该接口用于查询自动备份策略。
	DescribeLogBackupPolicy	该接口用于查询PolarDB集群日志备份的保留策略。
	ModifyBackupPolicy	该接口用于修改自动备份策略。
	ModifyLogBackupPolicy	该接口用于修改PolarDB集群的日志备份保留策略。

恢复

API	描述
DescribeMetaList	该接口用于查看支持恢复的库表元信息详情。
RestoreTable	该接口用于恢复PolarDB库表。

从RDS迁移

API	描述
DescribeDBClusterMigration	该接口用于查询PolarDB集群的迁移状态。
ModifyDBClusterMigration	该接口用于RDS一键迁移到PolarDB时进行切换或回滚。
CloseDBClusterMigration	该接口用于取消或完成迁移。

标签

API	描述
TagResources	该接口用于为PolarDB集群绑定标签。
UntagResources	该接口用于将标签从PolarDB集群上解绑。
ListTagResources	该接口用于查询一个或多个PolarDB集群已绑定的标签列表，或者查询一个或多个标签绑定的PolarDB集群列表。

待处理事件

API	描述
DescribePendingMaintenanceAction	该接口用于查询待处理事件的详情。
DescribePendingMaintenanceActions	该接口用于查询不同任务类型下待处理事件的数量。
ModifyPendingMaintenanceAction	该接口用于修改待处理事件的任务切换时间。

定时任务

API	描述
DescribeScheduleTasks	该接口用于查询当前账号下所有或指定的定时任务详情。
CancelScheduleTasks	该接口用于取消目标定时任务。

监控

API	描述
DescribeDBNodePerformance	该接口用于查询PolarDB集群节点的性能数据。
DescribeDBClusterPerformance	该接口用于查询PolarDB集群的性能数据。
DescribeDBClusterMonitor	该接口用于查询PolarDB集群的监控数据采集频率。
ModifyDBClusterMonitor	该接口用于修改PolarDB集群的监控数据采集频率。

PolarDB for AI

API	描述
OpenAITask	该接口用于开启PolarDB for AI功能。
DescribeAITaskStatus	该接口用于查看PolarDB for AI功能状态。
CloseAITask	该接口用于关闭PolarDB for AI功能。