文档

API概览

更新时间:
本产品(云数据库 PolarDB/2017-08-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

售卖管理

API标题API概述
CreateStoragePlan新建存储计划购买存储包。
DescribeAutoRenewAttribute查询集群自动续费状态查询PolarDB包年包月集群自动续费状态。
DescribeClassList查询polardb集群的规格列表查看集群规格列表。
DescribeDBClusterAvailableResources查询PolarDB集群可售卖资源查询PolarDB集群可售卖资源。
EvaluateRegionResource资源评估进行资源评估。
ModifyAutoRenewAttribute设置包年包月集群自动续费状态设置PolarDB包年包月集群自动续费状态。
TransformDBClusterPayType变更数据库集群付费类型变更PolarDB集群的计费方式。

集群管理

API标题API概述
CreateDBCluster创建集群创建PolarDB集群。
DeleteDBCluster释放按量付费的PolarDB集群释放按量付费的PolarDB集群。
DescribeDBClusters查询集群列表查询PolarDB集群列表或被RAM授权的集群列表详情。
DescribeDBClusterAttribute查看PolarDB集群的详细属性查看PolarDB集群的详细属性。
DescribeDBClusterServerlessConf查询Serverless集群的配置查询Serverless集群的配置。
DescribePolarSQLCollectorPolicy查询集群SQL洞察功能查看目标集群的SQL洞察功能是否已开启。
DescribeRegions查看用户可选的地域和可用区查询PolarDB支持的地域和可用区。
DescribeTasks获取任务列表查看通过API生成的任务(如创建集群)进度详情。
DescribeVSwitches查询已创建的交换机查询交换机。
ModifyDBCluster修改集群功能配置修改PolarDB MySQL集群的功能配置。
ModifyDBClusterDescription修改集群名称修改PolarDB集群名称。
ModifyDBClusterDeletion开启或者关闭集群保护锁开启或者关闭集群保护锁。
ModifyDBClusterMaintainTime修改实例集群可维护时间段修改PolarDB集群可例行维护的时间。
EnableDBClusterServerless开启稳态Serverless开启稳态Serverless。
DisableDBClusterServerless关闭稳态Serverless关闭稳态Serverless。
ModifyDBClusterServerlessConf修改Serverless集群配置修改Serverless集群配置。
ModifyDBClusterStorageSpace变更企业版按空间计费集群和标准版集群的存储空间变更企业版按空间计费集群和标准版集群的存储空间。
ManuallyStartDBCluster手动启动集群手动启动集群。

高可用部署架构

API标题API概述
ModifyDBClusterPrimaryZone更换PolarDB集群的可用区更换PolarDB集群的可用区。
FailoverDBCluster对集群进行手动主备切换对PolarDB集群进行手动主备切换,可以指定一个只读节点为新的主节点。

内核版本管理

API标题API概述
DescribeDBClusterVersion查看PolarDB MySQL集群内核版本信息查看PolarDB MySQL集群当前内核版本的详细信息。
UpgradeDBClusterVersion升级PolarDB MySQL版集群的内核版本升级PolarDB MySQL版集群的内核版本。

白名单管理

API标题API概述
DescribeDBClusterAccessWhitelist查看集群的IP白名单查看允许访问数据库集群的IP白名单和安全组。
ModifyDBClusterAccessWhitelist创建或修改集群的白名单创建或修改集群的白名单(包括IP白名单和安全组)。

全局IP白名单模板管理

API标题API概述
CreateGlobalSecurityIPGroup创建全局白名单创建全局IP白名单模板。
DeleteGlobalSecurityIPGroup删除全局白名单删除全局IP白名单模板。
DescribeGlobalSecurityIPGroup查询全局IP白名单模板列表查询全局IP白名单模板列表。
DescribeGlobalSecurityIPGroupRelation查询关联关系查询集群与全局IP白名单模板的关联关系。
ModifyGlobalSecurityIPGroup修改全局白名单修改IP白名单模板。
ModifyGlobalSecurityIPGroupName修改全局白名单名称修改全局IP白名单模板名称。
ModifyGlobalSecurityIPGroupRelation修改全局白名单关联关系修改集群与全局IP白名单模板的关联关系。

SSL加密

API标题API概述
DescribeDBClusterSSL查询PolarDB集群SSL设置查询PolarDB集群SSL设置。
ModifyDBClusterSSL设置集群SSL开通、关闭PolarDB集群的SSL加密功能,或更新PolarDB集群的CA证书。

TDE加密

API标题API概述
CheckKMSAuthorized检查kms密钥是否已存在查看用户KMS开通状态。
DescribeDBClusterTDE查询PolarDB集群的TDE设置详情查询PolarDB MySQL引擎集群的TDE设置详情。
DescribeUserEncryptionKeyList查询实例自定义密钥列表查看KMS密钥列表。
ModifyDBClusterTDE开启MySQL TDE功能开启PolarDB MySQL TDE功能或修改加密方式。

节点管理

API标题API概述
CreateDBNodes增加PolarDB集群的只读节点增加PolarDB集群的只读节点。
DeleteDBNodes删除PolarDB集群的只读节点删除PolarDB集群的只读节点。
ModifyDBNodeClass变更PolarDB集群节点规格变更PolarDB集群节点规格。
ModifyDBNodesClass变更PolarDB集群单个节点的规格变更PolarDB集群单个节点的规格。
ModifyDBNodeHotReplicaMode开启或关闭集群热备节点开启或关闭集群热备节点。
RestartDBNode重启PolarDB集群节点重启PolarDB集群节点。
TempModifyDBNode为集群临时升配或增加节点为集群临时升配或增加节点。
TempModifyDBNode为集群临时升配或增加节点为集群临时升配或增加节点。

参数管理

API标题API概述
CreateParameterGroup创建参数模板创建PolarDB参数模板。
DescribeDBClusterParameters查看PolarDB集群当前参数运行列表查看PolarDB集群当前参数运行列表。
DescribeDBNodesParameters查询集群中指定节点的参数查询集群中指定节点的参数。
DescribeParameterTemplates查询参数模版列表查询数据库集群默认参数的列表。
DescribeParameterGroups查询参数模板列表查看目标地域的参数模板列表。
DescribeParameterGroup查询指定的参数模板信息查询目标参数模板详情。
DeleteParameterGroup删除参数模板删除PolarDB参数模板。
ModifyDBClusterAndNodesParameters修改集群参数并应用到指定节点修改集群参数并应用到指定节点。
ModifyDBClusterParameters修改PolarDB集群的参数修改PolarDB集群的参数或将已有的参数模板应用到目标集群上。
ModifyDBNodesParameters修改单个节点的参数并应用到指定节点修改单个节点的参数并应用到指定节点。

访问地址管理

API标题API概述
CreateDBClusterEndpoint创建自定义集群地址创建PolarDB自定义集群地址。
CreateDBEndpointAddress创建集群公网连接地址创建PolarDB集群主地址、默认集群地址和自定义集群地址的公网连接地址。
DescribeDBClusterEndpoints查询PolarDB集群的地址信息查询PolarDB集群的地址信息。
ModifyDBClusterEndpoint修改PolarDB的集群地址属性修改PolarDB的集群地址属性,包括读写模式、新节点是否自动加入本地址、一致性级别、事务拆分、主库是否接受读、连接池等。
ModifyDBEndpointAddress修改集群连接地址修改PolarDB集群的连接地址,包括主地址、默认集群地址、自定义集群地址和私有域名。
DeleteDBClusterEndpoint释放PolarDB自定义集群地址释放PolarDB自定义集群地址。
DeleteDBEndpointAddress释放集群公网地址释放PolarDB集群的公网地址,包括主地址、默认集群地址和自定义的集群地址的公网连接地址。

日志管理

API标题API概述
DescribeSlowLogRecords查看慢日志明细查看PolarDB集群的慢日志明细。
DescribeSlowLogs查询PolarDB集群的慢日志统计信息查询PolarDB集群的慢日志统计信息。
DescribeDBClusterAuditLogCollector查询集群SQL采集功能查询PolarDB集群的SQL采集功能(例如审计日志、SQL洞察等)。
ModifyDBClusterAuditLogCollector开启或关闭集群的SQL采集功能开启或关闭PolarDB集群的SQL采集功能(例如审计日志、SQL洞察等)。

账号管理

API标题API概述
CreateAccount创建PolarDB数据库账号创建PolarDB数据库账号。
CheckAccountName校验账号是否合法校验账号名称是否合法或当前集群中是否已存在重名的账号。
DescribeAccounts查询数据库账号信息查询PolarDB集群的数据库账号信息。
ModifyAccountDescription修改数据库账号的备注信息修改PolarDB数据库账号的备注信息。
GrantAccountPrivilege授权普通账号访问某个数据库授权普通账号访问PolarDB集群的某个数据库。
RevokeAccountPrivilege撤销账号对数据库的访问权限移除PolarDB普通账号对数据库的访问权限。
ResetAccount重置高权限账号权限重置PolarDB高权限账号。
DeleteAccount删除数据库账号删除PolarDB数据库账号。
ModifyAccountPassword修改数据库的账号密码修改PolarDB数据库的账号密码。

数据库管理

API标题API概述
CreateDatabase为PolarDB集群创建一个新的数据库为PolarDB集群创建一个新的数据库。
DeleteDatabase删除PolarDB集群下的数据库删除PolarDB集群下的数据库。
DescribeDatabases查询PolarDB指定集群的数据库详情查询PolarDB指定集群的数据库详情。
DescribeCharacterSetName查看数据库支持的字符集列表查看PolarDB MySQL版数据库支持的字符集列表。
CheckDBName校验数据库名称是否合法校验数据库名称是否合法或当前集群中是否已存在重名的数据库。
DescribeDBInitializeVariable查询数据库属性查询PolarDB PostgreSQL版(兼容Oracle)或PolarDB PostgreSQL版数据库支持的字符集、排序规则等属性。
ModifyDBDescription修改数据库备注说明修改PolarDB MySQL版数据库的备注说明。

全球数据库网络(GDN)管理

API标题API概述
CreateGlobalDatabaseNetwork新建全球数据库网络创建一个新的全球数据库网络(GDN)。
DeleteGlobalDatabaseNetwork删除全球数据库网络删除全球数据库网络(GDN)。
DescribeGlobalDatabaseNetwork查询全球数据库网络查询全球数据库网络(GDN)详情。
DescribeGlobalDatabaseNetworks查看所有全球数据库网络(GDN)详情查看账号下所有全球数据库网络(GDN)的详情。
ModifyGlobalDatabaseNetwork修改全球数据库网络修改全球数据库网络(GDN)。
RemoveDBClusterFromGDN从全球数据库网络(GDN)中移除从集群从全球数据库网络(GDN)中移除从集群。
SwitchOverGlobalDatabaseNetwork切换全球数据库网络切换全球数据库网络(GDN)中的主从集群。
ResetGlobalDatabaseNetwork重建GDN中的从集群网络重建GDN中的从集群网络。

备份管理

API标题API概述
CreateBackup为PolarDB集群创建全量快照备份为PolarDB集群创建全量快照备份。
DescribeBackups查看备份集列表查询PolarDB集群的备份信息。
DescribeBackupTasks查询备份任务列表查询集群的备份任务详情。
DescribeBackupLogs查询备份日志列表查询备份日志列表、获取备份日志下载地址。
DescribeDetachedBackups查询已被释放集群中备份集详情查询已被释放的PolarDB集群中备份集详情。
DescribeDBClustersWithBackups查询包含备份集的集群详情查询某地域下包含备份集的PolarDB集群详情。
DeleteBackup删除PolarDB集群的备份删除PolarDB集群的备份。
备份策略备份策略
DescribeBackupPolicy查看PolarDB集群自动备份策略查看PolarDB集群的自动备份策略。
DescribeLogBackupPolicy查询集群日志备份保留策略查询PolarDB集群日志备份的保留策略。
ModifyBackupPolicy修改备份策略设置修改PolarDB集群的自动备份策略。
ModifyLogBackupPolicy修改集群日志备份保留策略修改PolarDB集群的日志备份保留策略。

库表恢复

API标题API概述
DescribeMetaList查看支持恢复的库表信息详情查看支持恢复的库表信息详情。
RestoreTable恢复PolarDB实例的某些数据库或表到原实例恢复PolarDB库表。

从RDS迁移

API标题API概述
DescribeDBClusterMigration查询PolarDB集群的迁移状态查询PolarDB集群的迁移状态。
ModifyDBClusterMigration切换或回滚迁移任务切换或回滚RDS一键升级到PolarDB的迁移任务。
CloseDBClusterMigration取消或完成迁移取消或完成RDS一键升级到PolarDB的迁移任务。

标签管理

API标题API概述
TagResources为PolarDB集群添加标签为PolarDB集群添加标签。
UntagResources将标签从集群上解绑将标签从PolarDB集群上解绑。
ListTagResources查询一个或多个PolarDB集群已绑定的标签列表查询一个或多个PolarDB集群已绑定的标签列表,或者查询一个或多个标签绑定的PolarDB集群列表。

待处理事件管理

API标题API概述
DescribePendingMaintenanceAction查询待处理事件的详情查询待处理事件的详情。
DescribePendingMaintenanceActions查看不同任务类型下待处理事件的数量查看不同任务类型下待处理事件的数量。
ModifyPendingMaintenanceAction修改待处理事件的任务切换时间修改待处理事件的任务切换时间。

计划任务管理

API标题API概述
DescribeScheduleTasks查询定时任务详情查询所有定时任务的详情情况。
CancelScheduleTasks取消定时任务取消开始时间尚未到达的定时任务。

脱敏规则管理

API标题API概述
DescribeMaskingRules查询脱敏规则列表查询PolarDB集群下所有的脱敏规则或目标脱敏规则的详情。
ModifyMaskingRules修改脱敏规则修改脱敏规则配置或新增脱敏规则。
DeleteMaskingRules删除脱敏规则删除目标脱敏规则。

监控管理

API标题API概述
DescribeDBNodePerformance查询集群节点的性能数据查询PolarDB集群节点的性能数据。
DescribeDBClusterPerformance查询PolarDB集群的性能数据查询PolarDB集群的性能数据。
DescribeDBProxyPerformance查询PolarDB代理层(PolarProxy)的性能数据查询PolarDB代理层(PolarProxy)的性能数据。
DescribeDBClusterMonitor查询集群监控数据采集频率查询PolarDB集群的监控数据采集频率。
ModifyDBClusterMonitor修改集群监控数据采集频率修改PolarDB集群的监控数据采集频率。

PolarDB for AI

API标题API概述
DescribeAITaskStatus获取AI任务状态数据查看PolarDB for AI功能状态。
OpenAITask开启AI任务开启PolarDB for AI功能。
CloseAITask关闭AI任务关闭PolarDB for AI功能。

DBLink

API标题API概述
CreateDBLink创建DBLink创建DBLink。
RestartDBLink重启代理重启代理。
DeleteDBLink删除集群中DBLink删除PolarDB PostgreSQL版(兼容Oracle)集群中的DBLink。
DescribeDBLinks查询集群DBLink信息查询PolarDB PostgreSQL版(兼容Oracle)集群的DBLink信息。

连接诊断

API标题API概述
DescribeDBClusterConnectivity查询源IP地址能否正常访问数据库调用接口DescribeDBClusterConnectivity查询源IP地址能否正常访问数据库。

冷数据归档

API标题API概述
CreateColdStorageInstance创建冷存储实例创建冷存储实例。

其他

API标题API概述
DescribeDasConfig查看集群 DAS 配置查看集群对应的DAS配置。
  • 本页导读 (0)