OpenAPI 导航

实例管理类API

实例管理类 API 可实现对 PolarDB-X 实例的生命周期管理,主要包括创建实例、查询实例、释放实例等操作,如下表所示。

API 名称

API 描述

CreateDrdsInstance

创建 PolarDB-X 实例

DescribeDrdsInstance

查看 PolarDB-X 实例详情

ModifyDrdsInstanceDescription

修改 PolarDB-X 实例描述

DescribeDrdsInstances

查看 PolarDB-X 实例列表

RemoveDrdsInstance

释放 PolarDB-X 实例

DescribeRegions

查询 PolarDB-X 的 Region 信息

数据库管理类 API

数据库管理类 API 可实现对 PolarDB-X 数据库的运行管理,包括建库、删库、 主备读写策略等操作,如下表所示。

API 名称

API 描述

CeateDrdsDB

创建数据库

DescribeDrdsDB

查询数据库

DeleteDrdsDB

删除数据库

ModifyDrdsDBPasswd

重置数据库密码

DescribeDrdsDBs

查询数据库列表

ModifyDrdsIpWhiteList

修改数据库白名单

DescribeDrdsDBIpWhiteList

查询数据库白名单

ModifyRdsReadWeight

设置读策略

DeleteFailedDrdsDB

删除创建/删除失败的库

DescribeShardDBs

查询分库列表

DescribeRdsList

查询数据库的 RDS 列表

ModifyFullTableScan

设置全表扫描

CreateReadOnlyAccount

创建只读账户

DescribeReadOnlyAccount

查询只读账户

ModifyReadOnlyAccountPassword

修改只读账户密码

RemoveReadOnlyAccount

删除只读账户

CreateDrdsAccount

创建读写账户