Beyond the console, integrate Tair (Redis OSS-compatible) through OpenAPI, the Alibaba Cloud SDK, or Resource Orchestration Service (ROS).
OpenAPI portal
The OpenAPI Portal provides API search, documentation, online debugging, SDK generation, code samples, error diagnosis, and call statistics. Use it to call APIs across Alibaba Cloud services, view requests and responses, and generate SDK sample code. What is OpenAPI?
API versions
Alibaba Cloud OpenAPI organizes the APIs for Tair (Redis OSS-compatible) by version.
|
Version |
Description |
|
Recommended. |
Online debugging
Tair (Redis OSS-compatible) supports API debugging on the OpenAPI Portal. Before calling an API, review the Tair (Redis OSS-compatible) version, endpoints, and integration methods.
URL for online debugging: https://api.alibabacloud.com/api/R-kvstore/2015-01-01/CreateInstance
The page displays parameters such as RegionId, Token, InstanceName, Password, Capacity, and InstanceClass. Specify the values and click Initiate Call. The right panel shows the API documentation, response, SDK sample, CLI sample, and error codes.
Endpoints
Select an endpoint based on your instance's region to minimize latency.
For example, the VPC endpoint for China (Zhangjiakou) is r-kvstore-vpc.cn-zhangjiakou.aliyuncs.com. All region endpoints are listed in Endpoints.
Supported user identities
The OpenAPI Portal uses your current account for debugging by default. Using an Alibaba Cloud account poses a high security risk because it has full API access. Use a RAM user instead for API access and daily operations, and grant only the permissions your business requires. Before making API calls, grant the RAM user the necessary permissions to operate Tair (Redis OSS-compatible). Use RAM for access control.
|
User identity |
Supported |
|
Yes |
|
|
RAM user (Recommended) |
Yes |
|
RAM role (Recommended) |
Yes |
Integration methods
Tair (Redis OSS-compatible) supports multiple integration methods. Choose one based on your requirements.
|
Integration method |
Supported |
Description |
|
Alibaba Cloud SDK (Recommended) SDKs are available for Java, C#, Go, Python, Swift, TypeScript, PHP, and C++. They handle authentication, signatures, and other low-level details, letting you call OpenAPI operations directly. |
Yes |
Supported languages and dependencies for the Tair (Redis OSS-compatible) SDK: Tair (Redis OSS-compatible) SDK. |
|
A command-line tool that uses the |
Yes |
Run |
|
Resource Orchestration Service (ROS) ROS simplifies cloud resource management. Define resources (such as ECS and RDS instances) and their dependencies in templates, and the ROS engine automatically creates and configures them. |
Yes |
Supported Tair (Redis OSS-compatible) resources and data sources for ROS: Resource types (Redis). |
If these methods don't meet your requirements, you can build custom API requests using the Request body and signature mechanism for V3, though this approach is not recommended.
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.