云原生数据库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集群进行主备切换，可以指定一个只读节点为新的主节点。
续费管理DescribeAutoRenewAttribute该接口用于查询PolarDB包年包月集群自动续费状态。
ModifyAutoRenewAttribute该接口用于设置PolarDB包年包月集群自动续费状态。
DescribeDBClusterAvailableResources该接口用于查询PolarDB集群可售卖资源。

数据安全

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

节点

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描述
DescribeDBClusterAuditLogCollector该接口用于查询PolarDB集群的SQL采集功能是否开启，SQL采集包括审计日志、SQL洞察等功能。
ModifyDBClusterAuditLogCollector该接口用于开启或关闭PolarDB集群的SQL采集功能，SQL采集包括审计日志、SQL洞察等功能。

账号

API描述
CreateAccount该接口用于为PolarDB数据库创建账号。
DescribeAccounts该接口用于查询PolarDB集群的数据库账号信息。
CheckAccountName该接口用于校验账号名称是否合法或当前集群中是否已存在重名的账号。
ModifyAccountDescription该接口用于修改PolarDB数据库账号的备注信息。
ModifyAccountPassword该接口用于修改PolarDB数据库的账号密码。
DeleteAccount该接口用于删除PolarDB数据库账号。

数据库

API描述
CreateDatabase该接口用于在PolarDB集群下创建一个新的数据库。
DescribeDatabases该接口用于查询PolarDB指定集群的数据库列表信息。
DeleteDatabase该接口用于删除PolarDB集群下的数据库。
DescribeDBInitializeVariable该接口用于查看PolarDB PostgreSQL版（兼容Oracle）数据库支持的字符集、排序规则等属性。
CheckDBName该接口用于校验数据库名称是否合法或当前集群中是否已存在重名的数据库名称。

DBLink

API描述
CreateDBLink该接口用于创建PolarDB PostgreSQL版（兼容Oracle）集群的DBLink。
DescribeDBLinks该接口用于查询PolarDB PostgreSQL版（兼容Oracle）集群的DBLink信息。
DeleteDBLink该接口用于删除PolarDB PostgreSQL版（兼容Oracle）的集群的DBLink。

备份

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

标签

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

待处理事件

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

定时任务

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

监控

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