OpenAPI reference-PolarDB(PolarDB)-阿里云帮助中心

Instance management APIs

Instance management APIs are used to manage the lifecycle of PolarDB-X instances. These operations include creating, querying, and releasing instances.

API name	API description
CreateDrdsInstance	Create a PolarDB-X instance
DescribeDrdsInstance	View the details of a PolarDB-X instance
ModifyDrdsInstanceDescription	Modify the description of a PolarDB-X instance
DescribeDrdsInstances	View a list of PolarDB-X instances
RemoveDrdsInstance	Release a PolarDB-X instance
DescribeRegions	Query the region information of PolarDB-X

Database management APIs

Database management APIs are used to manage PolarDB-X databases. These operations include creating and deleting databases, and setting read/write policies.

API name	API description
CeateDrdsDB	Create a database
DescribeDrdsDB	Query a database
DeleteDrdsDB	Delete a database
ModifyDrdsDBPasswd	Reset a database password
DescribeDrdsDBs	Query a list of databases
ModifyDrdsIpWhiteList	Modify a database whitelist
DescribeDrdsDBIpWhiteList	Query a database whitelist
ModifyRdsReadWeight	Set a read policy
DeleteFailedDrdsDB	Delete a database that failed to be created or deleted
DescribeShardDBs	Query a list of database shards
DescribeRdsList	Query a list of RDS instances for a database
ModifyFullTableScan	Set full table scan
CreateReadOnlyAccount	Create a read-only account
DescribeReadOnlyAccount	Query a read-only account
ModifyReadOnlyAccountPassword	Modify the password of a read-only account
RemoveReadOnlyAccount	Delete a read-only account
CreateDrdsAccount	Create a read/write account