分布式关系型数据库 DRDS_API文档

分布式关系型数据库 DRDS - OpenAPI 概览2019-01-23
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
实例管理
OpenAPI 名称描述操作
CreateDrdsInstancehot创建新实例查看文档去调试
CreateOrderForRds创建购买RDS的订单查看文档去调试
DescribeDrdsInstanceshot通过DescribeDrdsInstances接口查询DRDS实例列表查看文档去调试
DescribeDrdsDbInstancehot查询 DRDS 的 RDS 存储实例详情查看文档去调试
DescribeDrdsInstancehot查询实例详情查看文档去调试
DescribeDrdsParams查询参数列表查看文档去调试
DescribeDrdsTasks查询实例变更任务查看文档去调试
DescribeHotDbList查看热点扩容的数据库列表查看文档去调试
DescribeInstanceSwitchAzone查看是否可以切换可用区查看文档去调试
DescribeInstanceSwitchNetwork查询实例是否可以切换网络查看文档去调试
DescribeInstDbLogInfo查询数据库支持导入历史SQL数据的时间范围查看文档去调试
DescribePreCheckResult查看预检结果查看文档去调试
DescribeRdsCommodity查询存储层售卖数据查看文档去调试
ModifyDrdsInstanceDescription修改实例描述查看文档去调试
UpdateResourceGroupAttribute将实例转移至新的资源组查看文档去调试
RemoveDrdsInstance释放目标实例查看文档去调试
数据库管理
OpenAPI 名称描述操作
CreateDrdsDBhot创建DRDS数据库查看文档去调试
DescribeDrdsDBshot查看实例下的数据库详情查看文档去调试
DescribeDrdsDB查询实例下的数据库详情查看文档去调试
DescribeDrdsDbInstanceshot查询 DRDS 数据库下面的 RDS 列表查看文档去调试
DescribeDrdsDbRdsNameList查询存储实例列表查看文档去调试
DescribeDrdsShardingDbs查询PolarDB-X下的水平拆分数据库查看文档去调试
CheckDrdsDbName检查DRDS的数据库名是否合法查看文档去调试
RemoveDrdsDbFailedRecord删除建库失败记录查看文档去调试
RemoveDrdsDb删除DRDS下面的数据库查看文档去调试
存储管理
OpenAPI 名称描述操作
DescribeRdsPerformanceSummary查询RDS性能(如CPU)详情查看文档去调试
DescribeRdsSuperAccountInstances获取RDS高权限账号查看文档去调试
DescribeDrdsDBCluster查询DRDS逻辑库下PolarDB集群具体信息查看文档去调试
DescribeRDSPerformance查询存储层RDS性能数据详情查看文档去调试
DescribeDbInstanceshot查看存储层(如RDS或PolarDB)的实例列表查看文档去调试
DescribeDbInstanceDbs查看目标存储实例下的数据库列表查看文档去调试
ModifyRdsReadWeight修改RDS实例的读写权重查看文档去调试
账号管理
OpenAPI 名称描述操作
CreateInstanceAccount创建DRDS实例级账号查看文档去调试
RemoveInstanceAccount删除实例管理账号查看文档去调试
SQL审计
OpenAPI 名称描述操作
DescribeDrdsSqlAuditStatus查询DRDS SQL审计信息查看文档去调试
DescribeInstDbSlsInfo查询SQL审计时使用的SLS Project和LogStore的名称查看文档去调试
DescribeDrdsSlowSqlshot查看DRDS慢SQL查看文档去调试
EnableSqlAudit开启SQL审计功能查看文档去调试
DisableSqlAudit取消SQL审计查看文档去调试
CheckSqlAuditEnableStatus校验DRDS逻辑库SQL审计是否已开启查看文档去调试
备份和恢复
OpenAPI 名称描述操作
DescribeBackMenu查询实例是否支持备份恢复查看文档去调试
DescribeRestoreOrder查看本次恢复购买的订单详情查看文档去调试
DescribeBackupDbs查询可以恢复的数据库列表查看文档去调试
DescribeBackupSets查询备份集信息查看文档去调试
DescribeBackupPolicy查看备份策略设置详情查看文档去调试
DescribeBackupTimes查看实例可恢复到的目标时间查看文档去调试
StartRestore启动基于备份的恢复任务查看文档去调试
SetBackupPolicy设置备份策略查看文档去调试
EnableSqlFlashbackMatchSwitch此时DRDS数据库使用的RDS的BINLOG中会增加执行QUERY的信息查看文档去调试
RemoveBackupsSet删除备份集查看文档去调试
PutStartBackup通过调用PutStartBackup接口提交数据备份任务查看文档去调试
网络和连接
OpenAPI 名称描述操作
CreateInstanceInternetAddress为DRDS实例创建公网IP查看文档去调试
UpdateInstanceNetwork切换DRDS实例的网络类型查看文档去调试
ReleaseInstanceInternetAddress保证实例安全性查看文档去调试
安全
OpenAPI 名称描述操作
DescribeDrdsDBIpWhiteList查看目标数据库的IP白名单列表查看文档去调试
ModifyDrdsIpWhiteList修改数据库白名单查看文档去调试
扩容管理
OpenAPI 名称描述操作
SubmitCleanTask提交清理扩容任务查看文档去调试
SubmitSmoothExpandPreCheck提交平滑扩容预检任务查看文档去调试
CheckExpandStatus校验DRDS数据库是否可进行平滑扩容等扩容操作查看文档去调试
SubmitHotExpandTask提交热点扩容任务查看文档去调试
SubmitHotExpandPreCheckTask主要包括无主键表的检查查看文档去调试
任务管理
OpenAPI 名称描述操作
DescribeSqlFlashbakTask查看闪回任务的列表查看文档去调试
SubmitSqlFlashbackTask提交SQL闪回任务查看文档去调试
表拆分
OpenAPI 名称描述操作
CreateShardTask创建拆分任务查看文档去调试
DescribeInstanceAccounts查询实例账号信息查看文档去调试
DescribeExpandLogicTableInfoList查看拆分键查看文档去调试
DescribeTable查询table结构信息查看文档去调试
DescribeTableListByType根据类型获取表集合查看文档去调试
DescribeShardTaskInfo查询拆分变更工具详情查看文档去调试
ValidateShardTask校验拆分变更任务是否合法查看文档去调试
广播表
OpenAPI 名称描述操作
DescribeBroadcastTables查询广播表查看文档去调试
SetupBroadcastTables设置广播表查看文档去调试
SwitchGlobalBroadcastType将广播表从多写切换成异步链路模式查看文档去调试
数据表管理
OpenAPI 名称描述操作
DescribeTables获取表信息列表查看文档去调试
SetupTable使用全表扫描查看文档去调试
标签和参数设置
OpenAPI 名称描述操作
ListTagResources查询资源标签查看文档去调试
SetupDrdsParams配置实例的参数查看文档去调试
TagResources为资源打标签查看文档去调试
UntagResources取消资源的标签查看文档去调试
实例版本
OpenAPI 名称描述操作
DescribeDrdsInstanceVersion查询 DRDS 实例版本查看文档去调试
DescribeDrdsInstanceLevelTasks查询实例中未完成的任务查看文档去调试
UpgradeInstanceVersion升级DRDS实例的版本。 查看文档去调试
性能监控
OpenAPI 名称描述操作
DescribeDrdsInstanceMonitorhot查询实例监控数据详情查看文档去调试
DescribeDrdsInstanceDbMonitor查询数据库的性能监控数据查看文档去调试
其他
OpenAPI 名称描述操作
ChangeAccountPassword重置DRDS数据库密码查看文档去调试
ChangeInstanceAzone切换 DRDS 实例可用区查看文档去调试
DescribeBackupLocal查看本地日志设置查看文档去调试
DescribeDrdsRdsInstances查看目标PolarDB-X实例下所有的私有定制RDS实例详情查看文档去调试
DescribeRecycleBinStatus查看表回收站状态查看文档去调试
DescribeRecycleBinTables查询可回收的表查看文档去调试
EnableInstanceIpv6Address创建IPv6地址查看文档去调试
FlashbackRecycleBinTable恢复删除的逻辑表查看文档去调试
GetDrdsDbRdsRelationInfo查询数据库存储实例结构查看文档去调试
ManagePrivateRds管理存储层私有定制RDS实例查看文档去调试
ModifyAccountDescription修改账号描述查看文档去调试
ModifyAccountPrivilege修改账号权限查看文档去调试
ModifyPolarDbReadWeight修改PolarDB的读写权重查看文档去调试
RefreshDrdsAtomUrlRDS连接变更后,刷新DRDS分库连接保证其到RDS的链路畅通查看文档去调试
RemoveRecycleBinTable清除回收站中的表查看文档去调试
RestartDrdsInstance重启实例查看文档去调试
RollbackInstanceVersion回滚DRDS实例的版本查看文档去调试
SetBackupLocal修改备份策略查看文档去调试
SetupRecycleBinStatus开启表回收站查看文档去调试
SubmitSmoothExpandPreCheckTask提交平滑扩容预检任务查看文档去调试
UpdatePrivateRdsClass升级或降级存储层私有定制RDS实例的规格查看文档去调试
UpgradeHiStoreInstance升级 DRDS 列式存储的版本查看文档去调试