This topic describes the differences between ApsaraDB for OceanBase APIs and OceanBase Cloud APIs.
Differences in calling
The following table describes the main differences in calling between ApsaraDB for OceanBase APIs and OceanBase Cloud APIs.
Item |
ApsaraDB for OceanBase |
OceanBase Cloud |
|---|---|---|
| Service endpoint | The service endpoint is https://oceanbase.aliyuncs.com, and you must use an Alibaba Cloud API Gateway. |
The service endpoint is https://api.oceanbase.com, and you must use an OceanBase Cloud API service. |
| Authentication method | You must use Alibaba Cloud AccessKey ID and AccessKey secret for signature authentication. | You must use OceanBase Cloud AccessKey ID and AccessKey secret for signature authentication. |
| Request format | The request format follows the Alibaba Cloud API specification. You must use the Action parameter to specify the API operation. |
The request format follows the RESTful API specification. You must use HTTP methods and paths to specify the API operation. |
| Response format | The response is in XML or JSON format and contains the RequestId field. |
The response is in JSON format and contains the requestId field (in camel case). |
| Parameter differences | Some APIs have different parameter names and structures. For more information, see the details of each API. When you migrate code, check the parameter names, data types, and required fields. | Some APIs have different parameter names and structures. For more information, see the details of each API. When you migrate code, check the parameter names, data types, and required fields. |
| Error handling | The error codes follow the Alibaba Cloud error code specification. | The error codes follow the OceanBase Cloud error code specification. |
Before you migrate APIs, we recommend that you view the API docs to learn about the parameter and response format differences.
For more information about APIs of ApsaraDB for OceanBase, see API overview and Authorization information.
For more information about APIs of OceanBase Cloud, see API access.