云数据库PolarDB提供以下相关API接口。

地域

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

集群

API 描述
ModifyDBClusterMaintainTime 该接口用于修改PolarDB集群可例行维护的时间,一般设置为业务的低峰时间段。阿里云会在您设置的可维护时间段内进行集群维护,保证对业务的影响降到最低。
DescribeDBClusters 该接口用于查询PolarDB集群列表或被RAM授权的集群列表。
ModifyDBClusterDescription 该接口用于修改PolarDB集群名称,方便集群的维护。
CreateDBCluster 该接口用于创建PolarDB集群。
DeleteDBCluster 该接口用于释放按量付费的PolarDB集群。
DescribeDBClusterAttribute 该接口用于查看指定PolarDB集群的详细属性。
ModifyAutoRenewAttribute 该接口用于设置PolarDB包年包月集群自动续费状态。
DescribeAutoRenewAttribute 该接口用于查询PolarDB包年包月集群自动续费状态。
FailoverDBCluster 该接口用于手动对PolarDB集群进行主备切换,可以指定一个只读节点为新的主节点。
ModifyDBClusterPrimaryZone 调用ModifyDBClusterPrimaryZone更换PolarDB集群的主可用区。
DescribeDBClusterAvailableResources 调用DescribeDBClusterAvailableResources接口查询PolarDB集群可售卖资源。

白名单

API 描述
ModifyDBClusterAccessWhitelist 该接口用于创建或修改PolarDB集群的白名单(包括IP白名单和安全组)
DescribeDBClusterAccessWhitelist 该接口用于查看允许访问数据库集群的IP白名单和安全组。

安全和加密

API 描述
DescribeDBClusterSSL 调用DescribeDBClusterSSL接口查询PolarDB集群SSL设置。
ModifyDBClusterSSL 调用ModifyDBClusterSSL接口设置PolarDB集群SSL加密的开通、关闭或更新CA证书。

节点

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

集群参数

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

访问地址

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

日志

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

账号

API 描述
CreateAccount 该接口用于为PolarDB数据库创建账号。
DescribeAccounts 该接口用于查询PolarDB集群的数据库账号信息。
ModifyAccountDescription 该接口用于修改PolarDB数据库账号的备注信息。
DeleteAccount 该接口用于删除PolarDB数据库账号。
GrantAccountPrivilege 该接口用于授权普通账号访问PolarDB集群的某个数据库,一个账号可关联一个或多个数据库。
RevokeAccountPrivilege 该接口用于移除PolarDB普通账号对数据库的访问权限。
ResetAccount 该接口用于重置PolarDB高权限账号。
ModifyAccountPassword 该接口用于修改PolarDB数据库的账号密码。

数据库

API 描述
CreateDatabase 该接口用于在PolarDB集群下创建一个新的数据库。
DescribeDatabases 该接口用于查询PolarDB指定集群的数据库列表信息。
DeleteDatabase 该接口用于删除PolarDB集群下的数据库。
ModifyDBDescription 该接口用于修改PolarDB数据库的描述或备注信息。

备份

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

标签

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

监控

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