API概览-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

API标准及多语言预置SDK

本产品（Drds/2019-01-23）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

实例管理

API	标题	API概述
CreateDrdsInstance	创建一个实例	创建新实例。
CreateOrderForRds	创建购买RDS的订单	调用CreateOrderForRds接口创建购买RDS的订单。
ModifyDrdsInstanceDescription	修改实例描述	调用ModifyDrdsInstanceDescription接口修改实例描述。
UpdateResourceGroupAttribute	将实例转移至新的资源组	调用UpdateResourceGroupAttribute接口将实例转移至新的资源组。
DescribeDrdsInstances	查询DRDS实例列表	通过DescribeDrdsInstances接口查询DRDS实例列表。
DescribeDrdsDbInstance	查询 RDS 存储实例详情	查询 DRDS 的 RDS 存储实例详情。
DescribeDrdsInstance	查询 DRDS 实例详情	调用DescribeDrdsInstance接口查询实例详情。
DescribeDrdsParams	查询 DRDS 的参数列表	调用DescribeDrdsParams接口查询参数列表。
DescribeDrdsTasks	查询实例变更任务	调用DescribeDrdsTasks接口查询实例变更任务。
DescribeHotDbList	查看热点扩容db列表	调用DescribeHotDbList接口查看热点扩容的数据库列表。
DescribeInstanceSwitchAzone	查看是否切换可用区	调用DescribeInstanceSwitchAzone接口查看是否可以切换可用区。
DescribeInstanceSwitchNetwork	查询实例是否可以切换网络	调用DescribeInstanceSwitchNetwork查询实例是否可以切换网络。
DescribeInstDbLogInfo	查询支持导入历史SQL数据时间范围	查询数据库支持导入历史SQL数据的时间范围。
DescribePreCheckResult	查看预检结果	调用DescribePreCheckResult接口查看预检结果。
DescribeRdsCommodity	查看RDS售卖数据	调用DescribeRdsCommodity接口查询存储层售卖数据。
RemoveDrdsInstance	释放目标实例	调用RemoveDrdsInstance接口释放目标实例。

数据库管理

API	标题	API概述
CreateDrdsDB	创建数据库实例	创建DRDS数据库。
DescribeDrdsDBs	查看实例下的数据库列表	调用DescribeDrdsDBs接口查看实例下的数据库详情。
DescribeDrdsDB	查看实例下的数据库详情	调用DescribeDrdsDB接口查询实例下的数据库详情。
DescribeDrdsDbInstances	查询数据库 RDS 列表	查询 DRDS 数据库下面的 RDS 列表。
DescribeDrdsDbRdsNameList	查询 DRDS 数据库存储实例列表	调用DescribeDrdsDbRdsNameList接口查询存储实例列表。
DescribeDrdsShardingDbs	查询DRDS下水平拆分数据库	调用DescribeDrdsShardingDbs接口查询PolarDB-X下的水平拆分数据库。
CheckDrdsDbName	检查DRDS的数据库名是否合法	调用CheckDrdsDbName接口检查DRDS的数据库名是否合法。
RemoveDrdsDbFailedRecord	删除建库失败记录	调用RemoveDrdsDbFailedRecord接口删除建库失败记录。
RemoveDrdsDb	删除数据库	删除DRDS下面的数据库。

存储管理

API	标题	API概述
ModifyRdsReadWeight	修改RDS实例的读写权重	调用ModifyRdsReadWeight接口修改RDS实例的读写权重。
DescribeRdsPerformanceSummary	查询RDS性能（如CPU）详情	调用DescribeRdsPerformanceSummary接口查询RDS性能（如CPU）详情。
DescribeRdsSuperAccountInstances	获取RDS高权限账号	调用DescribeRdsSuperAccountInstances获取RDS高权限账号。
DescribeDrdsDBCluster	查询逻辑库下PolarDB集群具体信息	查询DRDS逻辑库下PolarDB集群具体信息。
DescribeRDSPerformance	查询存储层RDS性能数据详情	调用DescribeRDSPerformance接口查询存储层RDS性能数据详情。
DescribeDbInstances	查看存储层实例列表	查看存储层（如RDS或PolarDB）的实例列表。
DescribeDbInstanceDbs	查看目标存储实例下的数据库列表	调用DescribeDbInstanceDbs接口查看目标存储实例下的数据库列表。

账号管理

API	标题	API概述
CreateInstanceAccount	创建 DRDS 实例级账号	调用CreateInstanceAccount接口创建DRDS实例级账号。
RemoveInstanceAccount	删除实例管理账号	调用RemoveInstanceAccount接口删除实例管理账号。

SQL审计

API	标题	API概述
EnableSqlAudit	开启SQL审计功能	调用EnableSqlAudit接口开启SQL审计功能。
DisableSqlAudit	取消SQL审计	调用DisableSqlAudit接口取消SQL审计。
DescribeDrdsSqlAuditStatus	查询DRDS SQL审计信息	调用DescribeDrdsSqlAuditStatus接口查询DRDS SQL审计信息。
DescribeInstDbSlsInfo	查询SLS和LogStore名称	查询SQL审计时使用的SLS Project和LogStore的名称。
DescribeDrdsSlowSqls	查看慢SQL	查看DRDS慢SQL。
CheckSqlAuditEnableStatus	校验DRDS逻辑库SQL审计是否已开启	调用CheckSqlAuditEnableStatus接口校验DRDS逻辑库SQL审计是否已开启。

备份和恢复

API	标题	API概述
StartRestore	启动基于备份的恢复任务	调用StartRestore接口启动基于备份的恢复任务。
SetBackupPolicy	设置备份策略	调用SetBackupPolicy接口设置备份策略。
EnableSqlFlashbackMatchSwitch	实现SQL闪回时精确恢复数据	此时DRDS数据库使用的RDS的BINLOG中会增加执行QUERY的信息。
DescribeBackMenu	查询实例是否支持备份恢复	调用DescribeBackMenu接口查询实例是否支持备份恢复。
DescribeRestoreOrder	查看本次恢复购买订单详情	查看本次恢复购买的订单详情。
DescribeBackupDbs	查询可以恢复的数据库列表	调用DescribeBackupDbs接口查询可以恢复的数据库列表。
DescribeBackupSets	查询备份集信息	调用DescribeBackupSets接口查询备份集信息。
DescribeBackupPolicy	查看集群自动备份策略	调用DescribeBackupPolicy接口查看备份策略设置详情。
DescribeBackupTimes	查询实例可恢复到的目标时间	调用DescribeBackupTimes接口查看实例可恢复到的目标时间。
RemoveBackupsSet	删除备份集	调用RemoveBackupsSet接口删除备份集。
PutStartBackup	通过提交数据备份任务	通过调用PutStartBackup接口提交数据备份任务。

网络和连接

API	标题	API概述
CreateInstanceInternetAddress	为DRDS实例创建公网IP	调用CreateInstanceInternetAddress接口为DRDS实例创建公网IP。
UpdateInstanceNetwork	切换DRDS实例的网络类型	调用UpdateInstanceNetwork接口切换DRDS实例的网络类型。
ReleaseInstanceInternetAddress	释放实例外网地址	保证实例安全性。

安全

API	标题	API概述
ModifyDrdsIpWhiteList	修改数据库白名单	调用ModifyDrdsIpWhiteList接口修改数据库白名单。
DescribeDrdsDBIpWhiteList	获取IP白名单列表	查看目标数据库的IP白名单列表。

扩容管理

API	标题	API概述
SubmitCleanTask	提交清理扩容任务	调用SubmitCleanTask接口提交清理扩容任务。
SubmitSmoothExpandPreCheck	提交平滑扩容预检任务	调用SubmitSmoothExpandPreCheck接口提交平滑扩容预检任务。
CheckExpandStatus	校验数据库是否可进行扩容操作	校验DRDS数据库是否可进行平滑扩容等扩容操作。
SubmitHotExpandTask	提交热点扩容任务	调用SubmitHotExpandTask接口提交热点扩容任务。
SubmitHotExpandPreCheckTask	提交热点扩容预检任务	主要包括无主键表的检查。

任务管理

API	标题	API概述
DescribeSqlFlashbakTask	查看闪回任务的列表	查看闪回任务的列表。
SubmitSqlFlashbackTask	提交SQL闪回任务	调用SubmitSqlFlashbackTask接口提交SQL闪回任务。

表拆分

API	标题	API概述
CreateShardTask	创建拆分任务	调用CreateShardTask接口创建拆分任务。
DescribeInstanceAccounts	查看实例账号信息	调用DescribeInstanceAccounts接口查询实例账号信息。
DescribeExpandLogicTableInfoList	查看逻辑表拆分建	调用DescribeExpandLogicTableInfoList接口查看拆分键。
DescribeTable	获取 Table 结构信息	调用DescribeTable接口查询table结构信息。
DescribeTableListByType	根据类型获取表集合	调用DescribeTableListByType接口根据类型获取表集合。
DescribeShardTaskInfo	拆分变更工具详情	调用DescribeShardTaskInfo查询拆分变更工具详情。
ValidateShardTask	校验拆分变更任务是否合法	调用ValidateShardTask接口校验拆分变更任务是否合法。

广播表

API	标题	API概述
SetupBroadcastTables	设置广播表	调用SetupBroadcastTables接口设置广播表。
DescribeBroadcastTables	查询广播表	调用DescribeBroadcastTables接口查询广播表。
SwitchGlobalBroadcastType	将广播表从多写切换成异步链路模式	调用SwitchGlobalBroadcastType接口将广播表从多写切换成异步链路模式。

数据表管理

API	标题	API概述
SetupTable	使用全表扫描	调用SetupTable接口使用全表扫描。
DescribeTables	获取表信息列表	调用DescribeTables接口获取表信息列表。

标签和参数设置

API	标题	API概述
SetupDrdsParams	配置实例的参数	调用SetupDrdsParams接口配置实例的参数。
ListTagResources	查询资源绑定的标签列表	调用ListTagResources查询资源标签。
TagResources	为资源打标签	调用TagResources接口为资源打标签。
UntagResources	取消资源的标签	调用UntagResources接口取消资源的标签。

实例版本

API	标题	API概述
DescribeDrdsInstanceVersion	查看实例版本	查询 DRDS 实例版本。
DescribeDrdsInstanceLevelTasks	查询 DRDS 实例级未完成任务	调用DescribeDrdsInstanceLevelTasks接口查询实例中未完成的任务。
UpgradeInstanceVersion	升级DRDS实例的版本	调用UpgradeInstanceVersion接口升级DRDS实例的版本。。

性能监控

API	标题	API概述
DescribeDrdsInstanceMonitor	查询实例监控数据详情	调用DescribeDrdsInstanceMonitor接口查询实例监控数据详情。
DescribeDrdsInstanceDbMonitor	查询数据库的性能监控数据	调用DescribeDrdsInstanceDbMonitor接口查询数据库的性能监控数据。

其他

API	标题	API概述
ChangeAccountPassword	重置DRDS数据库密码	调用ChangeAccountPassword接口重置DRDS数据库密码。
ChangeInstanceAzone	切换实例可用区	切换 DRDS 实例可用区。
DescribeBackupLocal	查看本地备份集	调用DescribeBackupLocal接口查看本地日志设置。
DescribeDrdsRdsInstances	私有定制RDS实例详情	查看目标PolarDB-X实例下所有的私有定制RDS实例详情。
DescribeRecycleBinStatus	查看表回收站状态	调用DescribeRecycleBinStatus接口查看表回收站状态。
DescribeRecycleBinTables	查询可回收的表	查询可回收的表。
EnableInstanceIpv6Address	创建IPv6地址	调用EnableInstanceIpv6Address接口创建IPv6地址。
FlashbackRecycleBinTable	恢复删除的逻辑表	恢复删除的逻辑表。
GetDrdsDbRdsRelationInfo	查询数据库存储实例结构	调用GetDrdsDbRdsRelationInfo接口查询数据库存储实例结构。
ManagePrivateRds	管理私有RDS	调用ManagePrivateRds接口管理存储层私有定制RDS实例。
ModifyAccountDescription	修改账号描述	调用ModifyAccountDescription接口修改账号描述。
ModifyAccountPrivilege	修改账号权限	修改账号权限。
ModifyPolarDbReadWeight	修改PolarDB的读写权重	调用ModifyPolarDbReadWeight接口修改PolarDB的读写权重。
RefreshDrdsAtomUrl	刷新DRDS分库连接	RDS连接变更后，刷新DRDS分库连接保证其到RDS的链路畅通。
RemoveRecycleBinTable	清除回收站中的表	清除回收站中的表。
RestartDrdsInstance	重启实例	调用RestartDrdsInstance接口重启实例。
RollbackInstanceVersion	回滚DRDS实例的版本	回滚DRDS实例的版本。
SetBackupLocal	设置本地备份集策略	修改备份策略。
SetupRecycleBinStatus	开启表回收站	调用SetupRecycleBinStatus接口开启表回收站。
SubmitSmoothExpandPreCheckTask	提交平滑扩容预检任务	提交平滑扩容预检任务。
UpdatePrivateRdsClass	升级或降级存储层私有定制RDS	升级或降级存储层私有定制RDS实例的规格。
UpgradeHiStoreInstance	升级Histore实例	升级 DRDS 列式存储的版本。