All Products
Search
Document Center

Tair:API overview

Last Updated:May 15, 2024

This topic describes the basic information and usage notes about the Tair API.

For information about Alibaba Cloud APIs, see Overview.

Basic information

Versions

Version

Description

2015-01-01

Recommended.

Note

Tair and ApsaraDB for Redis share a set of API operations.

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 r-kvstore-vpc.cn-zhangjiakou.aliyuncs.com as the endpoint. For more information, see Endpoints.

Protocols

The Remote Procedure Call (RPC) protocol is used.

Methods to call API operations

Method

Supported

Description

Alibaba Cloud SDK (recommended)

Yes

For information about the programming languages available for Tair SDKs and how to install dependencies, see ApsaraDB for Redis SDKs.

Alibaba Cloud CLI

Yes

None

ROS

Yes

None

Terraform

Yes

None

If the preceding methods cannot meet your business requirements, you can encapsulate custom API requests. 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.