Integration overview

Beyond the console, Tablestore provides SDKs, a CLI, and online OpenAPI debugging for integration. Choose the method that fits your Tablestore development needs.

Integration methods

Tablestore features are categorized into instance management and data management.

Instance management

Instance-level operations: create instances, manage tags and resource groups, and configure access control policies.
Data management

Table and data operations: create tables, run SQL queries, and integrate with big data systems.

The following table shows Tablestore feature support for each integration method.

Integration method		Support
		Instance management	Data management
SDK	Tablestore SDK	Not supported	Supported (Recommended)
	Alibaba Cloud SDK	Supported (Recommended)	Not supported
CLI		Partially supported	Partially supported
Client tool		Not supported	Partially supported
Terraform		Partially supported	Partially supported
Resource Orchestration Service (ROS)		Partially supported	Partially supported

SDK

Use the Tablestore SDK or Alibaba Cloud SDK to access Tablestore features.

Tablestore SDK

Tablestore provides SDKs for Java, Go, Python, Node.js, .NET, and PHP. The Tablestore SDK is recommended for table and data operations. The following table shows feature support by SDK.

Note

In the following table, "Supported" indicates that a feature is available, while "Not supported" indicates that it is unavailable.

Feature	Java	Go	Python	Node.js	.NET	PHP
Table operations	Supported	Supported	Supported	Supported	Supported	Supported
Global table operations	Supported	Not supported	Not supported	Not supported	Not supported	Not supported
Data operations: Basic features	Supported	Supported	Supported	Supported	Supported	Supported
Data operations: Local transactions	Supported	Supported	Supported	Supported	Not supported	Supported
Search Index: Basic features	Supported	Supported	Supported	Supported	Supported	Supported
Search Index: Vector search	Supported	Supported	Supported	Supported	Not supported	Not supported
Search Index: Statistical aggregation	Supported	Supported	Supported	Supported	Supported	Supported
Global secondary index	Supported	Supported	Supported	Supported	Supported	Supported
Local secondary index	Supported	Supported	Supported	Supported	Not supported	Supported
Tunnel Service	Supported	Supported	Not supported	Not supported	Not supported	Not supported
SQL query	Supported	Supported	Supported	Supported	Supported	Supported
Data lake delivery	Supported	Supported	Not supported	Not supported	Not supported	Not supported
Time series model	Supported	Supported	Supported	Not supported	Not supported	Not supported
Message model	Supported	Supported	Not supported	Not supported	Not supported	Not supported

Alibaba Cloud SDK

The Alibaba Cloud SDK calls OpenAPI operations of Alibaba Cloud services. Use it to manage instances.

You can also debug APIs online in the OpenAPI Portal. Appendix 1: OpenAPI.

CLI

The Tablestore CLI runs on Windows, Linux, and macOS. Use it to activate the Tablestore service and create instances.

Client tool

The Tablestore client tool provides a GUI for Windows and macOS. Use it for some table and data operations.

Terraform

Terraform is an open-source tool for managing infrastructure as code. Use the Terraform CLI to deploy and version configurations on Alibaba Cloud or other providers.

Tablestore features supported in Terraform: Terraform resources.
To integrate Tablestore with Terraform: Create a Tablestore instance using Terraform.

Resource Orchestration Service (ROS)

Resource Orchestration Service (ROS) manages cloud resources through templates. Define resources (such as ECS and RDS instances) and dependencies in a template, and ROS provisions and configures them automatically.

Tablestore features supported by ROS: Resource orchestration list.
To integrate Tablestore with ROS: ROS integration example.

Custom API calls

If these methods do not meet your needs, construct API requests directly (not recommended). API overview, V3 request body & signature mechanism.

FAQ

Tablestore: What is Tablestore?
Tablestore is a serverless table storage service optimized for massive structured data and IoT scenarios. Tablestore features list.

Appendix

Appendix 1: OpenAPI

The OpenAPI Portal provides API search, documentation, online debugging, SDK downloads, code samples, error diagnostics, and call statistics. Use it to call APIs, view requests and responses, and generate SDK examples.

Versions

Tablestore supports the 2020-12-09 API version. The string 2020-12-09 is a version identifier, not a date. It represents the complete and current set of APIs, not only those released after 2020-12-09.

Version	Description
2020-12-09	Recommended

Online debugging

Tablestore supports API debugging in the OpenAPI Portal. Before calling an API, review the versions, endpoints, and calling methods.

For example, to debug CreateInstance: the left pane lists API operations by instance, resource tag, access control policy, and region. In the center, select an endpoint such as China (Hangzhou), then configure parameters — required ones like InstanceName and ClusterType, and optional ones like InstanceDescription, ResourceGroupId, NetworkTypeACL, and NetworkSourceACL. Click Initiate Call to run the request. The right panel shows API documentation, SDK and CLI examples, error codes, and response parameters such as RequestId, Code, and Message.

Debugging entry point

The entry point for API debugging is https://next.api.aliyun.com/api/Tablestore/2020-12-09.

Endpoints

For the lowest latency, select the endpoint in the region where your resources reside.

Tablestore endpoints: Endpoints.

User identity

The OpenAPI Portal uses your Alibaba Cloud account for debugging by default. An Alibaba Cloud account has full API access, which poses a high security risk. We strongly recommend creating a RAM user for API access or daily O&M. Grant required permissions to the RAM user before calling an API. Use RAM for access control.

User identity	Support
Alibaba Cloud account	Supported
RAM user (Recommended)	Supported
RAM role (Recommended)	Supported

Notes

If an API call fails, check the returned error code to verify your request parameters and values.
Alternatively, record the returned RequestId or SDK error message and use the Alibaba Cloud OpenAPI Diagnostic Platform for self-service diagnosis.

Related information

上一篇: Development support 下一篇: Configure access credentials