All Products
Search
Document Center

Tablestore:Integration overview

Last Updated:Jul 01, 2025

In addition to the Tablestore console, Tablestore provides integration methods, such as OpenAPI Explorer, SDKs, and the Tablestore CLI. You can select a suitable integration method based on your business requirements to develop and use Tablestore.

Integration methods

Tablestore features are divided into the instance management and data management categories.

  • Instance management

    The instance management category includes operations and features related to instances. For example, when you create an instance, use tags and resource groups, or configure network access control lists (ACLs) for an instance, operations or features of the instance management category are used.

  • Data management

    The data management category includes operations and features related to tables and data. For example, when you can create a data table, perform SQL queries, or connect Tablestore to big data systems, operations or features of the data management category are used.

The supported Tablestore features vary based on the integration method that you use.

Integration method

Supported

Instance management

Data management

SDK

Tablestore SDK

No

Yes (recommended)

Alibaba Cloud SDK

Yes (recommended)

No

Tablestore CLI

Partially supported

Partially supported

Terraform

Partially supported

Partially supported

ROS

Partially supported

Partially supported

SDK

You can use Tablestore SDKs and Alibaba Cloud SDK to access Tablestore features.

  • Tablestore SDK

    Tablestore provides SDKs for multiple mainstream programming languages, such as Java, Go, Python, Node.js, .NET, and PHP. We recommend that you use Tablestore SDKs to perform operations on tables and data. The following table describes the features supported by different SDKs.

    Note

    In the following table, a check sign (√) indicates that the feature is supported, and a cross sign (×) indicates that the feature is not supported.

    Feature

    Java

    Go

    Python

    Node.js

    .NET

    PHP

    Operations on data tables

    Data operations: basic features

    Data operations: local transaction

    ×

    Search index: basic features

    Search index: KNN vector query

    ×

    ×

    Search index: aggregation

    Global secondary index

    Local secondary index

    ×

    Tunnel Service

    ×

    ×

    ×

    ×

    SQL query

    Data delivery to OSS

    ×

    ×

    ×

    ×

    TimeSeries model

    ×

    ×

    ×

    Timeline model

    ×

    ×

    ×

    ×

  • Alibaba Cloud SDK

    Alibaba Cloud SDK is an encapsulated program dependency package that is used to call the API operations of cloud services. You can use Alibaba Cloud SDK to perform operations on instances and manage instances.

    You can also use OpenAPI Explorer to perform online debugging. For more information, see Appendix 1: API overview.

Tablestore CLI

The Tablestore CLI provides simple and clear commands that you can run in Windows, Linux, and macOS. You can use the Tablestore CLI to perform operations on Tablestore. For example, you can use the Tablestore CLI to activate Tablestore or create instances.

Terraform

Terraform is an open source automated resource orchestration tool that you can use to programmatically manage IT resources. Terraform provides an easy-to-use CLI that allows you to deploy configuration files on Alibaba Cloud or third-party clouds and manage the versions of the configuration files.

ROS

Resource Orchestration Service (ROS) is an Alibaba Cloud service that can simplify the management of cloud computing resources. You can create templates to define the required Alibaba Cloud resources, such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, and the dependencies between the resources. ROS automatically creates and configures all resources based on the template to implement automated deployment and O&M.

Custom API encapsulation

If none of the preceding methods meet your business requirements, you can manually encapsulate API requests. However, this method is not recommended. For more information, see List of operations by function and Request syntax and signature method V3.

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.

Appendix

Appendix 1: API overview

Alibaba Cloud provides OpenAPI 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. OpenAPI Explorer also automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services.

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 indicate 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.

image

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.

For information about Tablestore endpoints, see Endpoints.

Identity

After you log on to OpenAPI Explorer by using your Alibaba Cloud account, OpenAPI Explorer automatically uses your Alibaba Cloud account to debug API operations online. 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

Alibaba Cloud account

Yes

RAM user (recommended)

Yes

RAM role (recommended)

Yes

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.

More information