This product(
gpdb/2016-05-03) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
| API | Title | Description |
|---|---|---|
| InitVectorDatabase | InitVectorDatabase | Initializes vector databases. |
| CreateNamespace | CreateNamespace | Creates a vector namespace. |
| DescribeNamespace | DescribeNamespace | Queries the information about a namespace. |
| DeleteNamespace | DeleteNamespace | Deletes a namespace. |
| ListNamespaces | ListNamespaces | Queries a list of namespaces. |
Query data
| API | Title | Description |
|---|---|---|
| DescribeCollection | DescribeCollection | Queries the information about a vector collection. |
| DeleteCollection | DeleteCollection | Deletes a vector collection. |
| GrantCollection | GrantCollection | Grants vector collection permissions to a namespace. |
| ListCollections | ListCollections | Queries a list of vector collections. |
| DeleteVectorIndex | DeleteVectorIndex | Deletes a vector index. |
| UpsertCollectionData | UpsertCollectionData | Uploads vector data to a vector collection. |
| DeleteCollectionData | DeleteCollectionData | Deletes vector data. |
Create instance
| API | Title | Description |
|---|---|---|
| CreateDBInstance | CreateDBInstance | Creates an AnalyticDB for PostgreSQL instance. |
Instance management
| API | Title | Description |
|---|---|---|
| DeleteDBInstance | DeleteDBInstance | Releases a pay-as-you-go AnalyticDB for PostgreSQL instance. |
| ModifyDBInstanceDescription | ModifyDBInstanceDescription | Changes the description of an AnalyticDB for PostgreSQL instance. |
| ModifyDBInstanceMaintainTime | ModifyDBInstanceMaintainTime | Modifies the maintenance window of an AnalyticDB for PostgreSQL instance. |
| ModifyDBInstanceResourceGroup | ModifyDBInstanceResourceGroup | Moves an AnalyticDB for PostgreSQL instance to a resource group. |
| ModifyVectorConfiguration | ModifyVectorConfiguration | Modifies the vector engine optimization configuration of an AnalyticDB for PostgreSQL instance. |
| PauseInstance | PauseInstance | Pauses an AnalyticDB for PostgreSQL instance. |
| RebalanceDBInstance | RebalanceDBInstance | Rebalances an AnalyticDB for PostgreSQL instance. |
| RestartDBInstance | RestartDBInstance | Restarts an AnalyticDB for PostgreSQL instance. |
| ResumeInstance | ResumeInstance | Resumes an AnalyticDB for PostgreSQL instance. |
| UpgradeDBVersion | UpgradeDBVersion | Upgrades the minor version of an AnalyticDB for PostgreSQL instance. |
Instance configuration change
| API | Title | Description |
|---|---|---|
| DescribeDataReDistributeInfo | DescribeDataReDistributeInfo | Queries the data redistribution information about an AnalyticDB for PostgreSQL V6.0 instance in elastic storage mode. |
| ModifyDBInstanceConfig | ModifyDBInstanceConfig | Changes the threshold of computing resources and the wait period of idle resources for an AnalyticDB for PostgreSQL instance in Serverless automatic scheduling mode. |
| UpgradeDBInstance | UpgradeDBInstance | Changes the configurations of an AnalyticDB for PostgreSQL instance. |
Instance information query
| API | Title | Description |
|---|---|---|
| DescribeDBClusterNode | DescribeDBClusterNode | Queries a list of nodes in an AnalyticDB for PostgreSQL instance. |
| DescribeDBInstanceAttribute | DescribeDBInstanceAttribute | Queries the information about an AnalyticDB for PostgreSQL instance. |
| DescribeDBInstances | DescribeDBInstances | Queries a list of AnalyticDB for PostgreSQL instances. |
| DescribeDBVersionInfos | DescribeDBVersionInfos | Queries the information about minor versions of AnalyticDB for PostgreSQL instances. |
| DescribeSupportFeatures | DescribeSupportFeatures | Queries the features that are supported by an AnalyticDB for PostgreSQL instance. |
Parameter management
| API | Title | Description |
|---|---|---|
| DescribeModifyParameterLog | DescribeModifyParameterLog | Queries the parameter modification logs of an AnalyticDB for PostgreSQL instance. |
| DescribeParameters | DescribeParameters | Queries the information about configuration parameters for an AnalyticDB for PostgreSQL instance. |
| ModifyParameters | ModifyParameters | Modifies the configuration parameters of an AnalyticDB for PostgreSQL instance. |
Backup and restoration
| API | Title | Description |
|---|---|---|
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup policy of an AnalyticDB for PostgreSQL instance. |
| DescribeDataBackups | DescribeDataBackups | Queries a list of backup sets of full backup or point-in-time backup for an AnalyticDB for PostgreSQL instance. |
| DescribeLogBackups | DescribeLogBackups | Queries a list of log backups. |
| ModifyBackupPolicy | ModifyBackupPolicy | Configures the backup policy of an AnalyticDB for PostgreSQL instance. |
Account management
| API | Title | Description |
|---|---|---|
| CreateAccount | CreateAccount | Creates a privileged account for an AnalyticDB for PostgreSQL instance. |
| DescribeAccounts | DescribeAccounts | Queries the information about database accounts for an AnalyticDB for PostgreSQL instance. |
| DescribeDiagnosisDimensions | DescribeDiagnosisDimensions | Queries all databases and database accounts for an AnalyticDB for PostgreSQL instance. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a database account for an AnalyticDB for PostgreSQL instance. |
| ResetAccountPassword | ResetAccountPassword | Resets the password of a database account for an AnalyticDB for PostgreSQL instance. |
Data sharing
| API | Title | Description |
|---|---|---|
| DescribeDataShareInstances | DescribeDataShareInstances | Queries the state of data sharing for AnalyticDB for PostgreSQL instances. |
| DescribeDataSharePerformance | DescribeDataSharePerformance | Queries the information about data sharing performance metrics. |
| SetDataShareInstance | SetDataShareInstance | Enables or disables data sharing for an AnalyticDB for PostgreSQL instance. |
Diagnostics and optimization
| API | Title | Description |
|---|---|---|
| DescribeDBClusterPerformance | DescribeDBClusterPerformance | Queries the information about performance metrics of an AnalyticDB for PostgreSQL instance within a time range. |
| DescribeDBInstanceDataBloat | DescribeDBInstanceDataBloat | Queries the information about data bloat for an AnalyticDB for PostgreSQL instance. |
| DescribeDBInstanceDataSkew | DescribeDBInstanceDataSkew | Queries the information about data skew for an AnalyticDB for PostgreSQL instance. |
| DescribeDBInstanceDiagnosisSummary | DescribeDBInstanceDiagnosisSummary | Queries the information about nodes in an AnalyticDB for PostgreSQL instance. |
| DescribeDBInstanceIndexUsage | DescribeDBInstanceIndexUsage | Queries the index usage of an AnalyticDB for PostgreSQL instance. |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance | Queries the information about performance metrics of an AnalyticDB for PostgreSQL instance within a time range. |
| DescribeDiagnosisMonitorPerformance | DescribeDiagnosisMonitorPerformance | Queries the details of query execution on an AnalyticDB for PostgreSQL instance. |
| DescribeDiagnosisRecords | DescribeDiagnosisRecords | Queries the information about SQL queries for an AnalyticDB for PostgreSQL instance. |
| DescribeDiagnosisSQLInfo | DescribeDiagnosisSQLInfo | Queries the information about a query for an AnalyticDB for PostgreSQL instance. |
| DescribeDownloadRecords | DescribeDownloadRecords | Queries the download records of query diagnostic information for an AnalyticDB for PostgreSQL instance. |
| DescribeDownloadSQLLogs | DescribeDownloadSQLLogs | Queries the last five download records of slow query logs for an AnalyticDB for PostgreSQL instance. |
| DescribeHealthStatus | DescribeHealthStatus | Queries the health status of an AnalyticDB for PostgreSQL instance and its nodes. |
| DescribeWaitingSQLInfo | DescribeWaitingSQLInfo | Queries the information about a lock-waiting query for an AnalyticDB for PostgreSQL instance. |
| DescribeWaitingSQLRecords | DescribeWaitingSQLRecords | Queries the lock diagnostic records of an AnalyticDB for PostgreSQL instance. |
| DownloadDiagnosisRecords | DownloadDiagnosisRecords | Downloads the information about query diagnostics of an AnalyticDB for PostgreSQL instance. |
| DownloadSQLLogsRecords | DownloadSQLLogsRecords | Download the slow query logs of an AnalyticDB for PostgreSQL instance. |
Plan management
| API | Title | Description |
|---|---|---|
| CreateDBInstancePlan | CreateDBInstancePlan | Creates a plan for an AnalyticDB for PostgreSQL instance. |
| DeleteDBInstancePlan | DeleteDBInstancePlan | Deletes a plan from an AnalyticDB for PostgreSQL instance. |
| DescribeDBInstancePlans | DescribeDBInstancePlans | Queries the information about plans for an AnalyticDB for PostgreSQL instance. |
| SetDBInstancePlanStatus | SetDBInstancePlanStatus | Enables or disables a plan for an AnalyticDB for PostgreSQL instance. |
| UpdateDBInstancePlan | UpdateDBInstancePlan | Modifies a plan for an AnalyticDB for PostgreSQL instance. |
Tag management
| API | Title | Description |
|---|---|---|
| DescribeTags | DescribeTags | Queries a list of tags for AnalyticDB for PostgreSQL instances. |
| ListTagResources | ListTagResources | Queries a list of tags that are added to AnalyticDB for PostgreSQL instances. |
| TagResources | TagResources | Creates and adds tags to AnalyticDB for PostgreSQL instances. |
| UntagResources | UntagResources | Removes tags from AnalyticDB for PostgreSQL instances. If the tags that you remove are not added to other instances, the tags are automatically deleted. |
Security management
| API | Title | Description |
|---|---|---|
| CheckServiceLinkedRole | CheckServiceLinkedRole | Queries whether a service-linked role is created. |
| CreateServiceLinkedRole | CreateServiceLinkedRole | Creates a service-linked role. |
| DescribeDBInstanceIPArrayList | DescribeDBInstanceIPArrayList | Queries the whitelists of IP addresses that are allowed to access an AnalyticDB for PostgreSQL instance. |
| DescribeDBInstanceSSL | DescribeDBInstanceSSL | Queries the SSL information about an AnalyticDB for PostgreSQL instance. |
| DescribeUserEncryptionKeyList | DescribeUserEncryptionKeyList | Queries a list of Key Management Service (KMS) keys. |
| ModifyDBInstanceSSL | ModifyDBInstanceSSL | Enables, disables, or updates SSL encryption for an AnalyticDB for PostgreSQL instance. |
| ModifySecurityIps | ModifySecurityIps | Modifies the IP address whitelist of an AnalyticDB for PostgreSQL instance. |
Log management
| API | Title | Description |
|---|---|---|
| DescribeDBInstanceErrorLog | DescribeDBInstanceErrorLog | Queries the error logs of an AnalyticDB for PostgreSQL instance. |
| DescribeSQLLogCount | DescribeSQLLogCount | Queries the number of audit logs for an AnalyticDB for PostgreSQL instance. |
| DescribeSQLLogsV2 | DescribeSQLLogsV2 | Queries SQL logs within a specific time range. |
| ModifySQLCollectorPolicy | ModifySQLCollectorPolicy | Enables or disables the SQL collection feature for an AnalyticDB for PostgreSQL instance. |
Network management
| API | Title | Description |
|---|---|---|
| AllocateInstancePublicConnection | AllocateInstancePublicConnection | Allocates a public endpoint for an AnalyticDB for PostgreSQL instance. |
| DescribeDBInstanceNetInfo | DescribeDBInstanceNetInfo | Queries the connection information of an instance. |
| DescribeRdsVpcs | DescribeRdsVpcs | Queries a list of VPCs. |
| DescribeRdsVSwitchs | DescribeRdsVSwitchs | Queries a list of vSwitches. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | Changes the endpoint of an AnalyticDB for PostgreSQL instance. |
| ReleaseInstancePublicConnection | ReleaseInstancePublicConnection | Releases the public endpoint of an AnalyticDB for PostgreSQL instance. |
| SwitchDBInstanceNetType | SwitchDBInstanceNetType | Switches between the internal and public endpoints of an AnalyticDB for PostgreSQL instance. |
Resource management
| API | Title | Description |
|---|---|---|
| DescribeAvailableResources | DescribeAvailableResources | Queries the information about available resources of AnalyticDB for PostgreSQL. |
| DescribeRegions | DescribeRegions | Queries a list of regions and zones where AnalyticDB for PostgreSQL is available. |
Sample dataset
| API | Title | Description |
|---|---|---|
| CreateSampleData | CreateSampleData | Creates a sample dataset for an AnalyticDB for PostgreSQL instance. |
| DescribeSampleData | DescribeSampleData | Queries whether a sample dataset is loaded to an AnalyticDB for PostgreSQL instance. |
| UnloadSampleData | UnloadSampleData | Releases a sample dataset from an AnalyticDB for PostgreSQL instance. |
Other
| API | Title | Description |
|---|---|---|
| DescribeSQLLogs | DescribeSQLLogs | Queries the SQL execution logs of an AnalyticDB for PostgreSQL instance. |