本文汇总了PolarDB-X 1.0支持的API接口。
实例管理
| API | 描述 |
|---|---|
| CreateDrdsInstance | 该接口用于创建一个PolarDB-X 1.0实例。 |
| DescribeDrdsInstance | 该接口用于查询PolarDB-X 1.0实例详情。 |
| DescribeDrdsInstances | 该接口用于查询PolarDB-X 1.0实例列表。 |
| RemoveDrdsInstance | 该接口用于释放PolarDB-X 1.0实例，只能释放后付费实例。
说明 变配中或者有关联数据库未删除的实例无法释放。
|
| RestartDrdsInstance | 该接口用于重启实例。 |
| ModifyDrdsInstanceDescription | 该接口用于修改实例描述。 |
| UpdateResourceGroupAttribute | 该接口用于将实例转移至新的资源组。 |
数据库管理
| API | 描述 |
|---|---|
| CreateDrdsDB | 该接口用于创建PolarDB-X 1.0数据库。 |
| CheckDrdsDbName | 该接口用于检查PolarDB-X 1.0的数据库名是否合法。 |
| RemoveDrdsDbFailedRecord | 该接口用于删除建库失败记录。 |
| RemoveDrdsDb | 该接口用于删除PolarDB-X 1.0下面的数据库。 |
| DescribeDrdsShardingDbs | 该接口用于查询PolarDB-X 1.0下水平拆分数据库。 |
| DescribeDrdsDB | 该接口用于查询实例下的目标数据库详情。 |
| DescribeDrdsDBs | 该接口用于查询PolarDB-X 1.0实例下所有数据库信息。 |
存储管理
| API | 描述 |
|---|---|
| DescribeRdsPerformanceSummary | 该接口用于查看存储资源RDS的相关性能。 |
| DescribeRdsSuperAccountInstances | 该接口用于获取存储资源RDS高权限账号。 |
| DescribeDrdsDBCluster | 该接口用于查询PolarDB-X 1.0逻辑库下PolarDB集群具体信息。 |
| DescribeDrdsDbInstance | 该接口用于查询PolarDB-X 1.0的存储资源RDS实例详情。 |
| DescribeDrdsDbInstances | 该接口用于查询PolarDB-X 1.0数据库下面的RDS列表。 |
| DescribeDrdsDbRdsNameList | 该接口用于查询PolarDB-X 1.0数据库存储实例列表。 |
| GetDrdsDbRdsRelationInfo | 该接口用于查询PolarDB-X 1.0数据库存储实例结构。 |
| ModifyRdsReadWeight | 该接口用于修改存储资源RDS的读写权重。 |
| ModifyPolarDbReadWeight | 该接口用于修改存储资源PolarDB的读写权重。 |
| ResetDrdsToRdsConnections | 该接口用于重置后端PolarDB-X 1.0到存储资源RDS连接数。 |
| DescribeRDSPerformance | 该接口用于查看存储资源RDS性能数据。 |
| DescribeDbInstances | 该接口用于查看存储层（如RDS或PolarDB）实例列表。 |
| DescribeDbInstanceDbs | 该接口用于查看某个存储实例下的数据库列表。 |
| DescribeStorageInstanceSubDbInfo | 该接口用于获取存储实例。 |
| DescribeRdsCommodity | 该接口用于查看存储资源RDS售卖数据。 |
账号管理
| API | 描述 |
|---|---|
| CreateInstanceAccount | 该接口用于创建PolarDB-X 1.0实例级账号。 |
| DescribeInstanceAccounts | 该接口用于查看实例账号信息。 |
| RemoveInstanceAccount | 该接口用于删除实例管理账号。 |
SQL审计
| API | 描述 |
|---|---|
| DescribeDrdsSqlAuditStatus | 该接口用于查询PolarDB-X 1.0 SQL审计信息。 |
| EnableSqlAudit | 该接口用于开启SQL审计功能。 |
| DescribeInstDbLogInfo | 该接口用于查询数据库支持导入历史SQL数据的时间范围。 |
| CheckSqlAuditEnableStatus | 该接口用于校验PolarDB-X 1.0逻辑库SQL审计是否已开启。 |
| DescribeInstDbSlsInfo | 该接口用于查询SQL审计时使用的SLS Project和LogStore名称。 |
| DisableSqlAudit | 该接口用于取消SQL审计。 |
备份和恢复
| API | 描述 |
|---|---|
| StartRestore | 该接口用于启动基于备份的恢复任务。 |
| RemoveBackupsSet | 该接口用于删除备份集。 |
| DescribeBackMenu | 该接口用于查询实例是否支持备份恢复。 |
| DescribeBackupTimes | 该接口用于查询实例可恢复到的目标时间。 |
| DescribeRestoreOrder | 该接口用于查看本次恢复购买的订单详情。 |
| DescribeBackupDbs | 该接口用于查询可以恢复的数据库列表。 |
| PutStartBackup | 该接口用于提交数据备份任务。 |
| SetBackupPolicy | 该接口用于设置备份策略。 |
| EnableSqlFlashbackMatchSwitch | 该接口用于执行PolarDB-X 1.0数据库使用存储资源RDS的BINLOG中的QUERY信息，精确恢复数据 |
| DescribeBackupSets | 该接口用于查看备份集信息。 |
网络和连接
| API | 描述 |
|---|---|
| UpdateInstanceNetwork | 该接口用于切换PolarDB-X 1.0实例的网络类型。 |
| ReleaseInstanceInternetAddress | 该接口用于释放实例外网地址，保证实例安全性。 |
| DescribeInstanceSwitchNetwork | 该接口用于查询实例是否可以切换网络。 |
| EnableInstanceIpv6Address | 该接口用于创建IPv6地址。 |
| CreateInstanceInternetAddress | 该接口用于为PolarDB-X 1.0实例创建公网IP。 |
| RefreshDrdsAtomUrl | 该接口用于存储资源RDS实例连接变更后，刷新PolarDB-X 1.0分库连接保证其到RDS的链路畅通。 |
扩容管理
| API | 描述 |
|---|---|
| SubmitCleanTask | 该接口用于提交平滑扩容（热点扩容）的清理任务。 |
| SubmitSmoothExpandPreCheck | 该接口用于提交平滑扩容预检任务。 |
| CheckExpandStatus | 该接口用于校验PolarDB-X 1.0数据库是否可进行平滑扩容等扩容操作。 |
| SubmitSmoothExpandTask | 该接口用于提交平滑扩容任务。 |
| SubmitSwitchTask | 该接口用于提交平滑扩容切换任务。 |
| SubmitRollbackTask | 该接口用于提交平滑扩容回滚任务。 |
任务管理
| API | 描述 |
|---|---|
| DescribeSqlFlashbakTask | 该接口用于查看闪回任务的列表。 |
| DescribeDrdsInstanceLevelTasks | 该接口用于查看闪回任务的列表。 |
| SubmitSqlFlashbackTask | 该接口用于提交SQL闪回任务。 |
| DescribePreCheckResult | 该接口用于查看任务预检结果。 |
| DescribeDrdsTasks | 该接口用于查询实例变更任务。 |
表拆分
| API | 描述 |
|---|---|
| ValidateShardTask | 该接口用于校验拆分变更任务是否合法。 |
| DescribeExpandLogicTableInfoList | 该接口用于查看拆分建。 |
| DatalinkReplicationPrecheck | 该接口用于拆分任务预检。 |
| CreateShardTask | 该接口用于创建拆分任务。 |
| DescribeShardTaskInfo | 该接口用于查看拆分变更工具详情。 |
| DeleteShardTasks | 该接口用于删除拆分任务。 |
广播表
| API | 描述 |
|---|---|
| DescribeBroadcastTables | 该接口用于查询广播表详情。 |
| DescribeGlobalBroadcastType | 该接口用于查询是否为广播表。 |
| SetupBroadcastTables | 该接口用于设置广播表。 |
| SwitchGlobalBroadcastType | 该接口用于将广播表从多写切换成异步链路模式。 |
数据表管理
| API | 描述 |
|---|---|
| DescribeTables | 该接口用于获取表信息列表。 |
| DescribeTableListByType | 该接口用于根据类型获取表集合。 |
| DescribeTable | 该接口用于获取表结构信息。 |
| SetupTable | 该接口用于设置表全表扫描。 |
标签和参数设置
| API | 描述 |
|---|---|
| TagResources | 该接口用于为实例打标签。 |
| UntagResources | 该接口用于取消实例的标签。 |
| ListTagResources | 该接口用于查看实例的标签。 |
| DescribeDrdsParams | 该接口用于查询PolarDB-X 1.0的参数列表。 |
| SetupDrdsParams | 该接口用于设置PolarDB-X 1.0参数。 |
实例版本
| API | 描述 |
|---|---|
| DescribeDrdsInstanceVersion | 该接口用于查询PolarDB-X 1.0实例版本。 |
| RollbackInstanceVersion | 该接口用于回滚PolarDB-X 1.0实例的版本。 |
| UpgradeInstanceVersion | 该接口用于升级PolarDB-X 1.0实例的版本 。 |
性能监控
| API | 描述 |
|---|---|
| DescribeDrdsInstanceMonitor | 该接口用于查询PolarDB-X 1.0实例监控数据。 |
| DescribeDrdsInstanceDbMonitor | 该接口用于查询PolarDB-X 1.0数据库的性能监控数据。 |
其它
| API | 描述 |
|---|---|
| DescribeDrdsDBIpWhiteList | 该接口用于查看数据库IP白名单列表。 |
| ModifyDrdsIpWhiteList | 该接口用于修改PolarDB-X 1.0数据库白名单。 |
| DescribeInstanceSwitchAzone | 该接口用于查看目标实例是否支持切换可用区。 |
| DescribeDrdsSlowSqls | 该接口用于查看PolarDB-X 1.0慢SQL。 |