本产品（
云数据库 PolarDB/2017-08-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
售卖管理
| API | 标题 | API概述 |
|---|---|---|
| CreateStoragePlan | 新建存储计划 | 购买存储包。 |
| DescribeAutoRenewAttribute | 查询集群自动续费状态 | 查询PolarDB包年包月集群自动续费状态。 |
| DescribeClassList | 查询polardb集群的规格列表 | 查看集群规格列表。 |
| DescribeDBClusterAvailableResources | 查询PolarDB集群可售卖资源 | 查询PolarDB集群可售卖资源。 |
| EvaluateRegionResource | 资源评估 | 进行资源评估。 |
| ModifyAutoRenewAttribute | 设置包年包月集群自动续费状态 | 设置PolarDB包年包月集群自动续费状态。 |
| TransformDBClusterPayType | 变更数据库集群付费类型 | 变更PolarDB集群的计费方式。 |
集群管理
| API | 标题 | API概述 |
|---|---|---|
| CreateDBCluster | 创建集群 | CreateDBCluster。 |
| DeleteDBCluster | 释放按量付费的PolarDB集群 | 释放按量付费的PolarDB集群。 |
| DescribeDBClusters | 查询集群列表 | 查询PolarDB集群列表或被RAM授权的集群列表详情。 |
| DescribeDBClusterAttribute | 查看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引擎集群的TDE设置详情。 |
| DescribeUserEncryptionKeyList | 查询实例自定义密钥列表 | 查看KMS密钥列表。 |
| ModifyDBClusterTDE | 开启PolarDB TDE功能 | ModifyDBClusterTDE |
节点管理
| 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数据库支持的字符集、排序规则等属性。 |
| 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配置。 |