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

计费

API 描述
TransformDBClusterPayType 调用TransformDBClusterPayType变更PolarDB集群的计费方式。

地域

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集群的参数或将已有的参数模板应用到目标集群上。
CreateParameterGroup 创建PolarDB集群的参数模板。
DescribeParameterGroups 查询PolarDB集群的参数模板列表。
DescribeParameterGroup 查询PolarDB集群的参数模板详情。
DescribeParameterTemplates 查询PolarDB集群默认参数的列表。
DeleteParameterGroup 删除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 描述
DescribeMaskingRules 查询PolarDB集群下所有的脱敏规则或目标脱敏规则的详情。
ModifyMaskingRules 修改脱敏规则配置或新增脱敏规则。
DeleteMaskingRules 删除目标脱敏规则。

监控

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