API概览
云数据库 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集群进行主备切换,可以指定一个只读节点为新的主节点。 |
白名单
API | 描述 |
---|---|
ModifyDBClusterAccessWhitelist | 该接口用于创建或修改PolarDB集群的白名单(包括IP白名单和安全组) |
DescribeDBClusterAccessWhitelist | 该接口用于查看允许访问数据库集群的IP白名单和安全组。 |
账号
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 | 描述 |
---|---|
DescribeDBClusterEndpoints | 该接口用于查询PolarDB集群的地址信息。 |
CreateDBEndpointAddress | 该接口用于创建PolarDB集群的公网地址,包括主地址、默认集群地址和自定义集群地址的公网地址。 |
ModifyDBEndpointAddress | 该接口用于修改PolarDB集群公网地址,包括主地址、默认集群地址和自定义集群地址的公网地址。 |
DeleteDBEndpointAddress | 该接口用于释放PolarDB集群的公网地址,包括主地址的公网链接、集群地址的公网链接以及自定义的集群地址的公网链接。 |
CreateDBClusterEndpoint | 该接口用于创建PolarDB自定义集群地址。 |
ModifyDBClusterEndpoint | 该接口用于修改PolarDB的集群地址属性,包括读写模式、新节点是否自动加入本地址、一致性级别等。 |
DeleteDBClusterEndpoint | 该接口用于释放PolarDB自定义集群地址。 |
集群参数
API | 描述 |
---|---|
DescribeDBClusterParameters | 该接口用于查看PolarDB集群的参数。 |
ModifyDBClusterParameters | 该接口用于修改PolarDB集群的参数。 |
节点
API | 描述 |
---|---|
RestartDBNode | 该接口用于重启PolarDB集群节点。 |
CreateDBNodes | 该接口用于增加PolarDB集群的只读节点。 |
DeleteDBNodes | 该接口用于删除PolarDB集群节点。 |
ModifyDBNodeClass | 该接口用于变更PolarDB集群节点规格。 |
标签
API | 描述 |
---|---|
TagResources | 该接口用于为PolarDB集群绑定标签。 |
UntagResources | 该接口用于将标签从PolarDB集群上解绑。 |
ListTagResources | 该接口用于查询一个或多个PolarDB集群已绑定的标签列表,或者查询一个或多个标签绑定的PolarDB集群列表。 |
从RDS迁移
API | 描述 |
---|---|
DescribeDBClusterMigration | 该接口用于查询PolarDB集群的迁移状态。 |
ModifyDBClusterMigration | 该接口用于RDS一键迁移到PolarDB时进行切换或回滚。 |
CloseDBClusterMigration | 该接口用于取消或完成迁移。 |
监控
API | 描述 |
---|---|
DescribeDBClusterPerformance | 该接口用于查询PolarDB集群的性能数据。 |
DescribeDBNodePerformance | 该接口用于查询PolarDB集群节点的性能数据。 |
日志
API | 描述 |
---|---|
DescribeSlowLogs | 该接口用于查询PolarDB集群的慢日志统计信息。 |
DescribeSlowLogRecords | 该接口用于查看PolarDB集群的慢日志明细。 |
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论