This topic describes the basic information and usage notes about the AnalyticDB for PostgreSQL API.
For more information about Alibaba Cloud APIs, see API overview.
Basic information
Versions
Version | Description |
For AnalyticDB for PostgreSQL instances, API operations of this version are called. |
Endpoints
You must select an endpoint based on the region of your instance to reduce the latency.
For example, if your instance resides in the China (Zhangjiakou) region and is deployed in a virtual private cloud (VPC), specify adb-vpc.cn-zhangjiakou.aliyuncs.com as the endpoint. For more information, see Endpoints.
User identities
User identity | Supported |
Yes | |
Resource Access Management (RAM) user (recommended) | Yes |
RAM role (recommended) | Yes |
Call methods
Call method | Supported | Description |
Alibaba Cloud SDK (recommended) | Yes | For information about the programming languages supported by AnalyticDB for PostgreSQL SDKs and the methods to install dependencies, see AnalyticDB for PostgreSQL SDKs. |
Alibaba Cloud CLI | Yes | For information about how to call the AnalyticDB for PostgreSQL API by using Alibaba Cloud CLI, see Alibaba Cloud CLI. |
Resource Orchestration Service (ROS) | Yes | For information about how to call the AnalyticDB for PostgreSQL API by using ROS, see the ROS documentation. |
Terraform | Yes | For information about how to call the AnalyticDB for PostgreSQL API by using Terraform, see the Terraform documentation. |
If the preceding methods cannot meet your business requirements, you can encapsulate API requests to call API operations. However, this method is not recommended. For more information, see Custom encapsulation.
Usage notes
If an error is returned after you call an API operation, you must check whether the request parameters and their values are valid based on the returned error code. For more information, see Error codes.
You can also use the Alibaba Cloud OpenAPI Diagnostics platform to perform self-service diagnostics based on the returned request ID or SDK error information.