Tablestore provides a console for visual operations and multiple methods for calling API operations, including OpenAPI Explorer, SDKs, CLI, Terraform, and Resource Orchestration Service (ROS). OpenAPI Explorer supports online debugging of API operations. To improve development efficiency by using Tablestore, we recommend that you use API operations and integration methods based on your business requirements.
Integration methods
Background information
Tablestore are classified into features related to access control links and features related to data links.
Access control links
You can manage instances over access control links. For example, you can create instances, configure tags for resources, configure access control lists (ACL) for instances, and query regions.
Data links
You can store, retrieve, and process data over data links. For example, you can create data tables, perform SQL queries, and connect to big data systems.
Integration overview
You can select a method to call API operations based on your business requirements. The following table describes the methods.
Calling method | Supported | ||
Access control link | Data link | ||
SDK | Yes (recommended) | No | |
No | Yes (recommended) | ||
CLI | Partially supported | Partially supported | |
No | No | ||
Partially supported | Partially supported | ||
Partially supported | Partially supported | ||
SDK
SDKs encapsulate the signing logic, timeout mechanisms, and retry mechanisms. After you call an SDK, a structured Response object is returned. This facilitates application development and provides more comprehensive features.
Alibaba Cloud SDKs
Alibaba Cloud provides SDKs for multiple programming languages, such as Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. You can integrate SDKs with your applications to directly call API operations. For more information, see Alibaba Cloud SDKs.
For information about the Tablestore API, see Appendix 1: API overview.
If the existing methods do not meet your business requirements, you can encapsulate a request for an API operation and call the operation. However, we do not recommend this method. For more information, see List of operations by function and Request syntax and signature method V3.
Tablestore SDK
Tablestore provides SDKs for multiple programming languages, such as Java, Go, Python, Node.js, .NET, and PHP. For more information about Tablestore SDKs, see SDK overview.
CLI
CLI is a user interface (UI) that allows you to interact with computers by using text commands. You can directly enter commands in the CLI to perform operations without the need to use a GUI.
Tablestore CLI
Tablestore CLI provides simple and clear commands that you can run in Windows, Linux, and macOS. For more information about Tablestore CLI, see Use the Wide Column model in the Tablestore CLI and Use the TimeSeries model in the Tablestore CLI.
Alibaba Cloud CLI
Alibaba Cloud CLI allows you to use
aliyuncommands to interact with Alibaba Cloud services and manage Alibaba Cloud resources. For more information about Alibaba Cloud CLI, see Use the TimeSeries model in the Tablestore CLI.You cannot use Alibaba Cloud CLI to call the API operations of Tablestore.
Terraform
Terraform is an open source tool that you can use to preview, configure, and manage cloud infrastructures and resources in a secure and efficient manner. Terraform works in the same manner as ROS. Terraform calls API operations by interpreting templates. For more information about Terraform, see What is Terraform?
You can use Terraform to orchestrate and use Tablestore.
For information about regular resources and data resources that are supported by Terraform, such as instances, data tables, search indexes, secondary indexes, and tunnels, see Resources supported by Terraform.
For information about how to use Terraform to orchestrate Tablestore, see Integrate Tablestore by using Terraform.
ROS
ROS is an Alibaba Cloud service that can simplify the management of cloud computing resources. You can compile stack templates to describe cloud computing resources, such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, and the dependencies between resources in the templates. The ROS engine automatically creates and configures all resources in a stack based on a template to implement automatic deployment and O&M. For more information, see What is ROS?
You can use ROS to call the API operations of Tablestore.
For information about regular resources and data resources that are supported by ROS, such as instances, data tables, search indexes, secondary indexes, and tunnels, see Resources supported by ROS.
For information about how to use ROS to orchestrate Tablestore, see Integrate Tablestore by using ROS.
Usage notes
If an error is returned after you call an API operation, check whether the request parameters and their values are valid based on the error code.
You can also perform self-service diagnostics based on the returned request ID or SDK error information on the OpenAPI problem diagnosis page.
References
For more information about Tablestore, see What is Tablestore?
Tablestore is a cost-effective table-based serverless storage service that can be used to store large volumes of structured data. Tablestore provides a deeply optimized and all-in-one storage solution for IoT applications. For more information about Tablestore features, see Functions and features.
Appendixes
Appendix 1: API overview
Alibaba Cloud provides OpenAPI Explorer to help developers use the API operations of various Alibaba Cloud services in an efficient manner. OpenAPI Explorer integrates multiple features related to API operations, such as intelligent search, documentation, online debugging, SDK download, sample code, error diagnosis, and call statistics. In OpenAPI Explorer, you can call the API operations of Alibaba Cloud services and view API requests and responses. In addition, OpenAPI Explorer automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services. For more information, see What is an API?
Versions
Alibaba Cloud APIs use versions to manage the API operations of cloud services that are available in different periods. For example, Tablestore supports API operations of the 2020-12-09 version. 2020-12-09 represents the API version instead of the date. The version provides all latest public API operations and does not mean that API operations are not updated since 2020-12-09.
Version number | Description |
2020-12-09 | We recommend that you use this version. |
Online debugging
Tablestore provides features such as API debugging in OpenAPI Explorer. Before you call API operations, make sure that you are familiar with the following information provided by Tablestore: versions, endpoints, API styles, and calling methods.
Debugging page
You can debug Tablestore API operations at https://next.api.alibabacloud.com/api/Tablestore/2020-12-09.
Endpoints
Select an endpoint based on the region where your resource resides to reduce latency.
Global endpoint: dyvmsapi.aliyuncs.com. For more information, see Endpoints.
User identities
After you log on to OpenAPI Explorer by using your Alibaba Cloud account, your Alibaba Cloud account is used to perform online debugging by default. An Alibaba Cloud account has permissions on all API operations. Using an Alibaba Cloud account to debug API operations online is a high-risk operation. We recommend that you call API operations or perform routine O&M as a RAM user. Before you call API operations as a RAM user, grant the required permissions to the RAM user based on your business requirements. For more information, see Use RAM for access control.
Identity | Supported |
Yes | |
RAM user (recommended) | Yes |
RAM role (recommended) | Yes |