This page lists all API operations available for PolarDB-X, grouped by functional area.
Instance management
Covers instance lifecycle, configuration, scaling, connectivity, and task monitoring.
| API | Description |
|---|---|
| CreateDBInstance | Creates a PolarDB-X instance. |
| CheckHealth | Checks the health status of PolarDB-X instances in a specified region. |
| ModifyDBInstanceMaintainTime | Changes the maintenance window of a PolarDB-X instance. |
| DeleteDBInstance | Deletes a PolarDB-X instance. |
| DescribeDBInstanceAttribute | Queries the attributes of a specified PolarDB-X instance. |
| DescribeDBInstanceConfig | Queries the parameters configured for a specified PolarDB-X instance. |
| DescribeDBInstanceTopology | Queries the topology of a specified PolarDB-X instance. |
| DescribeDBInstances | Queries the details of PolarDB-X instances in a specified region. |
| DescribeScaleOutMigrateTaskList | Queries the progress of the migration task performed to scale out a specified PolarDB-X instance. |
| DescribeTasks | Queries the tasks running on a specified PolarDB-X instance. |
| ModifyDBInstanceClass | Modifies the specifications of a specified PolarDB-X instance. |
| ModifyDBInstanceConfig | Modifies configuration items for a specified PolarDB-X instance. |
| ModifyDBInstanceDescription | Modifies the description of a specified PolarDB-X instance. |
| ReleaseInstancePublicConnection | Releases the public endpoint of a specified PolarDB-X instance. |
| RestartDBInstance | Restarts a PolarDB-X instance. |
| UpgradeDBInstanceKernelVersion | Changes the kernel version of a specified PolarDB-X instance. |
| UpdatePolarDBXInstanceNode | Changes the number of nodes in a specified PolarDB-X instance. |
| DescribeBinaryLogList | Queries the binary logs of a specified PolarDB-X instance. |
Database management
Covers database creation, deletion, schema queries, character sets, and table listings.
| API | Description |
|---|---|
| CreateDB | Creates a database. |
| DeleteDB | Deletes a database. |
| DescribeDbList | Queries the details of a database in a specified PolarDB-X instance. |
| DescribeTableDetail | Queries the schema of a specified table. |
| DescribeCharacterSet | Queries the character sets supported by databases in a specified PolarDB-X instance. |
| DescribeDistributeTableList | Queries the tables of a specified database. |
| ModifyDatabaseDescription | Modifies the description of a specified database. |
Region management
Covers region and zone discovery for PolarDB-X.
| API | Description |
|---|---|
| DescribeRegions | Queries the regions and zones supported by PolarDB-X. |
Account management
Covers standard and privileged account creation, deletion, password resets, privilege management, and three-role mode configuration.
| API | Description |
|---|---|
| CreateAccount | Creates a standard account. |
| CreateSuperAccount | Creates a privileged account. |
| DeleteAccount | Deletes a standard account. |
| DescribeAccountList | Queries the details of accounts created for a specified PolarDB-X instance. |
| ModifyAccountPrivilege | Modifies the permissions granted to a specified standard account. |
| ModifyAccountDescription | Modifies the description of a specified account. |
| ResetAccountPassword | Resets the password of a specified standard account. |
| EnableRightsSeparation | Enables the three-role mode. |
| DisableRightsSeparation | Disables the three-role mode. |
Data security
Covers public endpoint management, IP whitelists, Transparent Data Encryption (TDE), Key Management Service (KMS) authorization, and SSL encryption.
| API | Description |
|---|---|
| AllocateInstancePublicConnection | Creates a public endpoint for a specified PolarDB-X instance. |
| CheckCloudResourceAuthorized | Queries whether the account connected to a specified PolarDB-X instance is authorized to use Key Management Service (KMS). |
| DescribeDBInstanceTDE | Queries whether Transparent Data Encryption (TDE) is enabled for a specified PolarDB-X instance. |
| DescribeSecurityIps | Queries the details of whitelists configured for a specified PolarDB-X instance. |
| DescribeUserEncryptionKeyList | Queries the user-created encryption keys used for TDE. |
| ModifySecurityIps | Modifies the whitelists of a specified PolarDB-X instance. |
| UpdateDBInstanceTDE | Enables TDE for a specified PolarDB-X instance. |
Monitoring and logs
Covers performance data queries and slow query log retrieval.
| API | Description |
|---|---|
| DescribeDBNodePerformance | Queries the performance data of a specified PolarDB-X instance. |
| DescribeSlowLogRecords | Queries slow SQL query log details. |
Parameter management
Covers parameter queries, change logs, templates, and value updates.
| API | Description |
|---|---|
| DescribeParameters | Queries the details of configured parameters. |
| DescribeParameterTemplates | Queries the details of parameter templates. |
| DescribeModifyParameterLog | Queries the parameter change log. |
| ModifyParameter | Changes the values of specified parameters. |
SSL encryption
Covers SSL encryption configuration queries and updates.
| API | Description |
|---|---|
| DescribeDBInstanceSSL | Queries the SSL encryption configuration of a specified PolarDB-X instance. |
| UpdateDBInstanceSSL | Modifies the SSL encryption configuration of a specified PolarDB-X instance. |