本文汇总了PolarDB MySQL版所有对外公开的API接口,以及企业版和标准版对API接口的支持情况供您参考。
售卖管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateStoragePlan | 购买存储包。 | 支持 | 不支持 |
DescribeAutoRenewAttribute | 查询PolarDB包年包月集群自动续费状态。 | 支持 | 支持 |
DescribeClassList | 查看集群规格列表。 | 支持 | 支持 |
DescribeDBClusterAvailableResources | 查询PolarDB集群可售卖资源。 | 支持 | 支持 |
EvaluateRegionResource | 进行资源评估。 | 支持 | 支持 |
ModifyAutoRenewAttribute | 设置PolarDB包年包月集群自动续费状态。 | 支持 | 支持 |
TransformDBClusterPayType | 变更PolarDB集群的计费方式。 | 支持 | 不支持 |
集群管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateDBCluster | 创建PolarDB集群。 | 支持 | 支持 |
DeleteDBCluster | 释放按量付费的PolarDB集群。 | 支持 | 支持 |
DescribeDBClusters | 查询PolarDB集群列表或被RAM授权的集群列表。 | 支持 | 支持 |
DescribeDBClusterAttribute | 查询指定PolarDB集群的详细属性。 | 支持 | 支持 |
DescribeDBClusterServerlessConf | 查询Serverless集群的配置。 | 支持 | 不支持 |
DescribeRegions | 查询PolarDB支持的地域和可用区。 | 支持 | 支持 |
DescribeTasks | 查看通过API生成的任务(如创建集群)进度详情。 | 支持 | 不支持 |
ModifyDBClusterDescription | 修改PolarDB集群名称,方便集群的维护。 | 支持 | 支持 |
ModifyDBClusterDeletion | 开启或者关闭集群保护锁。 | 支持 | 支持 |
ModifyDBClusterMaintainTime | 修改PolarDB集群可例行维护的时间,一般设置为业务的低峰时间段。阿里云会在您设置的可维护时间段内进行集群维护,保证对业务的影响降到最小。 | 支持 | 支持 |
ModifyDBClusterServerlessConf | 修改Serverless集群配置。 | 支持 | 不支持 |
ModifyDBClusterStorageSpace | 修改集群版(按空间付费)和标准版集群的存储空间。 | 支持 | 支持 |
高可用部署架构
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
ModifyDBClusterPrimaryZone | 变更PolarDB集群的主可用区。 | 支持 | 不支持 |
FailoverDBCluster | 手动对PolarDB集群进行主备切换,可以指定一个只读节点为新的主节点。 | 支持 | 不支持 |
内核版本管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeDBClusterVersion | 查看PolarDB MySQL版集群当前内核版本的详细信息。 | 支持 | 支持 |
UpgradeDBClusterVersion | 升级PolarDB MySQL版集群当前的内核版本。 | 支持 | 支持 |
白名单管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
ModifyDBClusterAccessWhitelist | 创建或修改PolarDB集群的白名单(包括IP白名单和安全组)。 | 支持 | 支持 |
DescribeDBClusterAccessWhitelist | 查询允许访问PolarDB集群的IP白名单和安全组。 | 支持 | 支持 |
全局IP白名单模板管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateGlobalSecurityIPGroup | 创建全局IP白名单模板。 | 支持 | 支持 |
DeleteGlobalSecurityIPGroup | 删除全局IP白名单模板。 | 支持 | 支持 |
DescribeGlobalSecurityIPGroup | 查询全局IP白名单模板列表。 | 支持 | 支持 |
DescribeGlobalSecurityIPGroupRelation | 查询集群与全局IP白名单模板的关联关系。 | 支持 | 支持 |
ModifyGlobalSecurityIPGroup | 修改IP白名单模板。 | 支持 | 支持 |
ModifyGlobalSecurityIPGroupName | 修改全局IP白名单模板名称。 | 支持 | 支持 |
ModifyGlobalSecurityIPGroupRelation | 修改集群与全局IP白名单模板的关联关系。 | 支持 | 支持 |
SSL加密
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeDBClusterSSL | 查询PolarDB集群SSL设置。 | 支持 | 支持 |
ModifyDBClusterSSL | 设置PolarDB集群SSL加密的开通、关闭或更新CA证书。 | 支持 | 支持 |
TDE加密
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CheckKMSAuthorized | 查看用户KMS开通状态。 | 支持 | 支持 |
DescribeDBClusterTDE | 查询PolarDB集群的TDE设置详情。 | 支持 | 不支持 |
DescribeUserEncryptionKeyList | 查看PolarDB集群的KMS密钥列表。 | 支持 | 支持 |
ModifyDBClusterTDE | 开启PolarDB MySQL版集群的TDE功能或修改加密方式。 | 支持 | 不支持 |
脱敏规则管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeMaskingRules | 查询PolarDB集群下所有的脱敏规则或目标脱敏规则的详情。 | 支持 | 不支持 |
ModifyMaskingRules | 修改脱敏规则配置或新增脱敏规则。 | 支持 | 不支持 |
DeleteMaskingRules | 删除目标脱敏规则。 | 支持 | 不支持 |
节点管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateDBNodes | 增加PolarDB集群的只读节点。 | 支持 | 支持 |
ModifyDBNodeClass | 变更PolarDB集群节点规格。 | 支持 | 支持 |
ModifyDBNodesClass | 变更PolarDB集群单个节点的规格。 | 支持 | 支持 |
RestartDBNode | 重启PolarDB集群节点。 | 支持 | 支持 |
DeleteDBNodes | 删除PolarDB集群的只读节点。 | 支持 | 支持 |
TempModifyDBNode | 为PolarDB集群临时升配或增加节点。 | 支持 | 支持 |
参数管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateParameterGroup | 创建PolarDB参数模板。 | 支持 | 支持 |
DescribeDBClusterParameters | 查询PolarDB集群当前参数运行列表。 | 支持 | 支持 |
DescribeDBNodesParameters | 查询PolarDB集群中指定节点的参数。 | 支持 | 支持 |
DescribeParameterTemplates | 查询PolarDB集群默认的参数列表。 | 支持 | 支持 |
DescribeParameterGroups | 查看PolarDB集群目标地域的参数模板列表。 | 支持 | 支持 |
DescribeParameterGroup | 查询PolarDB集群目标参数模板详情。 | 支持 | 支持 |
DeleteParameterGroup | 删除PolarDB集群的参数模板。 | 支持 | 支持 |
ModifyDBClusterAndNodesParameters | 修改PolarDB集群的参数并应用到指定节点。 | 支持 | 支持 |
ModifyDBClusterParameters | 修改PolarDB集群的参数或将已有的参数模板应用到目标集群上。 | 支持 | 支持 |
ModifyDBNodesParameters | 修改PolarDB集群的单个节点的参数并应用到指定节点。 | 支持 | 支持 |
访问地址管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateDBEndpointAddress | 创建PolarDB集群的公网地址,包括主地址、默认集群地址和自定义集群地址的公网地址。 | 支持 | 支持 |
CreateDBClusterEndpoint | 创建PolarDB自定义集群地址。 | 支持 | 支持 |
DescribeDBClusterEndpoints | 查询PolarDB集群的地址信息。 | 支持 | 支持 |
ModifyDBClusterEndpoint | 修改PolarDB的集群地址属性,包括读写模式、新节点是否自动加入本地址、一致性级别等。 | 支持 | 支持 |
ModifyDBEndpointAddress | 修改PolarDB集群公网地址,包括主地址、默认集群地址和自定义集群地址的公网地址。 | 支持 | 支持 |
DeleteDBEndpointAddress | 释放PolarDB集群的公网地址,包括主地址的公网链接、集群地址的公网链接以及自定义的集群地址的公网链接。 | 支持 | 支持 |
DeleteDBClusterEndpoint | 释放PolarDB自定义集群地址。 | 支持 | 支持 |
日志管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeSlowLogRecords | 查询PolarDB集群的慢日志明细。 | 支持 | 支持 |
DescribeSlowLogs | 查询PolarDB集群的慢日志统计信息。 | 支持 | 支持 |
DescribeDBClusterAuditLogCollector | 查询PolarDB集群的SQL采集功能是否开启,SQL采集包括审计日志、SQL洞察等功能。 | 支持 | 支持 |
ModifyDBClusterAuditLogCollector | 开启或关闭PolarDB集群的SQL采集功能,SQL采集包括审计日志、SQL洞察等功能。 | 支持 | 支持 |
账号管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateAccount | 为PolarDB数据库创建账号。 | 支持 | 支持 |
DescribeAccounts | 查询PolarDB集群的数据库账号信息。 | 支持 | 支持 |
CheckAccountName | 校验账号名称是否合法或当前集群中是否已存在重名的账号。 | 支持 | 支持 |
ModifyAccountDescription | 修改PolarDB数据库账号的备注信息。 | 支持 | 支持 |
ModifyAccountPassword | 修改PolarDB数据库的账号密码。 | 支持 | 支持 |
GrantAccountPrivilege | 授权普通账号访问PolarDB集群的某个数据库,一个账号可关联一个或多个数据库。 | 支持 | 支持 |
RevokeAccountPrivilege | 移除PolarDB普通账号对数据库的访问权限。 | 支持 | 支持 |
ResetAccount | 重置PolarDB高权限账号。 | 支持 | 支持 |
DeleteAccount | 删除PolarDB数据库账号。 | 支持 | 支持 |
数据库管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateDatabase | 在PolarDB集群下创建一个新的数据库。 | 支持 | 支持 |
DescribeDatabases | 查询PolarDB指定集群的数据库列表信息。 | 支持 | 支持 |
ModifyDBDescription | 修改PolarDB数据库的描述或备注信息。 | 支持 | 支持 |
DeleteDatabase | 删除PolarDB集群下的数据库。 | 支持 | 支持 |
DescribeCharacterSetName | 查看PolarDB MySQL版数据库支持的字符集列表。 | 支持 | 支持 |
CheckDBName | 校验数据库名称是否合法或当前集群中是否已存在重名的数据库名称。 | 支持 | 支持 |
全球数据库网络(GDN)管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateGlobalDatabaseNetwork | 创建一个新的全球数据库网络(GDN)。 | 支持 | 不支持 |
DeleteGlobalDatabaseNetwork | 删除全球数据库网络(GDN)。 | 支持 | 不支持 |
DescribeGlobalDatabaseNetwork | 查询全球数据库网络(GDN)详情。 | 支持 | 不支持 |
DescribeGlobalDatabaseNetworks | 查看当前阿里云账号下所有全球数据库网络(GDN)列表。 | 支持 | 不支持 |
ModifyGlobalDatabaseNetwork | 修改全球数据库网络(GDN)。 | 支持 | 不支持 |
RemoveDBClusterFromGDN | 从全球数据库网络(GDN)中移除从集群。 | 支持 | 不支持 |
SwitchOverGlobalDatabaseNetwork | 切换全球数据库网络(GDN)中的主从集群。 | 支持 | 不支持 |
备份管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CreateBackup | 手动为PolarDB集群创建全量快照备份。 | 支持 | 支持 |
DescribeBackups | 查询PolarDB集群的备份信息。 | 支持 | 支持 |
DescribeBackupTasks | 查询PolarDB集群的备份任务列表。 | 支持 | 支持 |
DescribeBackupLogs | 查询备份日志列表、获取备份日志下载地址。 | 支持 | 支持 |
DescribeDetachedBackups | 查询已被释放的PolarDB集群中备份集的信息。 | 支持 | 不支持 |
DescribeDBClustersWithBackups | 查询某地域下包含备份集的PolarDB集群详情。 | 支持 | 不支持 |
DeleteBackup | 删除PolarDB集群的备份。 | 支持 | 支持 |
备份策略管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeBackupPolicy | 查询自动备份策略。 | 支持 | 支持 |
DescribeLogBackupPolicy | 查询PolarDB集群日志备份的保留策略。 | 支持 | 支持 |
ModifyBackupPolicy | 修改自动备份策略。 | 支持 | 支持 |
ModifyLogBackupPolicy | 修改PolarDB集群的日志备份保留策略。 | 支持 | 支持 |
库表恢复
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeMetaList | 查看支持恢复的库表元信息详情。 | 支持 | 不支持 |
RestoreTable | 恢复PolarDB库表。 | 支持 | 不支持 |
从RDS迁移
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeDBClusterMigration | 查询PolarDB集群的迁移状态。 | 支持 | 不支持 |
ModifyDBClusterMigration | RDS一键迁移到PolarDB时进行切换或回滚。 | 支持 | 不支持 |
CloseDBClusterMigration | 取消或完成迁移。 | 支持 | 不支持 |
标签管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
TagResources | 为PolarDB集群绑定标签。 | 支持 | 支持 |
UntagResources | 将标签从PolarDB集群上解绑。 | 支持 | 支持 |
ListTagResources | 查询一个或多个PolarDB集群已绑定的标签列表,或者查询一个或多个标签绑定的PolarDB集群列表。 | 支持 | 支持 |
待处理事件管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribePendingMaintenanceAction | 查询待处理事件的详情。 | 支持 | 支持 |
DescribePendingMaintenanceActions | 查询不同任务类型下待处理事件的数量。 | 支持 | 支持 |
ModifyPendingMaintenanceAction | 修改待处理事件的任务切换时间。 | 支持 | 支持 |
计划任务管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeScheduleTasks | 查看当前账号下所有或指定的计划任务详情。 | 支持 | 支持 |
CancelScheduleTasks | 取消目标计划任务。 | 支持 | 支持 |
监控管理
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeDBNodePerformance | 查询PolarDB集群节点的性能数据。 | 支持 | 支持 |
DescribeDBClusterPerformance | 查询PolarDB集群的性能数据。 | 支持 | 支持 |
DescribeDBClusterMonitor | 查询PolarDB集群的监控数据采集频率。 | 支持 | 支持 |
DescribeDBProxyPerformance | 查询PolarDB集群代理层(PolarProxy)的性能数据。 | 支持 | 支持 |
ModifyDBClusterMonitor | 修改PolarDB集群的监控数据采集频率。 | 支持 | 支持 |
PolarDB for AI
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
CloseAITask | 关闭PolarDB for AI功能。 | 支持 | 不支持 |
DescribeAITaskStatus | 查看PolarDB for AI功能状态。 | 支持 | 不支持 |
OpenAITask | 开启PolarDB for AI功能。 | 支持 | 不支持 |
连接诊断
API名称 | 描述 | 企业版 | 标准版 |
---|---|---|---|
DescribeDBClusterConnectivity | 查询源IP地址能否正常访问数据库。 | 支持 | 不支持 |
ManuallyStartDBCluster | 手动启动集群。 | 支持 | 不支持 |