OpenAPI集成

更新时间: 2024-09-27 17:46:54

除了通过操作可视化控制台以外,您还可以通过OpenAPI在线调试、阿里云SDK、Terraform、资源编排ROS等方式集成云数据库 Tair(兼容 Redis)

OpenAPI介绍

为了能够让您快速高效地学习和使用云产品OpenAPI,阿里云提供了OpenAPI网站。它是一款集OpenAPI智能搜索、文档、在线调试、SDK获取、CodeSample、调用出错诊断、调用统计为一体的产品。您可以在OpenAPI门户中调用阿里云各云产品开放的OpenAPI,查看OpenAPI请求和返回结果。此外,OpenAPI门户支持自动生成相应的SDK调用示例,帮助您快速使用阿里云产品。更多信息请参见什么是OpenAPI

版本说明

阿里云OpenAPI通过版本号管控云数据库 Tair(兼容 Redis)的API列表。

版本号

说明

2015-01-01

推荐使用

在线调试

云数据库 Tair(兼容 Redis)在OpenAPI门户提供API调试等功能。在调用前,您需要了解云数据库 Tair(兼容 Redis)提供的版本、接入点说明、集成方式等信息。

调试入口为:https://api.aliyun.com/api/R-kvstore/2015-01-01/CreateInstance

image

接入点说明

根据实例所在的地域,选择对应的服务接入点地址,以获得最低延迟。

例如华北3(张家口)的VPC接入地址为r-kvstore-vpc.cn-zhangjiakou.aliyuncs.com,更多信息请参见服务接入点

支持的用户身份

当您登录OpenAPI门户网站后,OpenAPI默认使用您所登录的账号进行在线OpenAPI调试。由于阿里云账号拥有所有API的访问权限,存在较高风险,因此不建议您使用阿里云账号在线调试API。强烈建议您创建并使用RAM用户进行API访问或日常运维,并根据业务的实际情况按需分配权限,再进行API调用。RAM用户需具备云数据库 Tair(兼容 Redis)操作的权限,具体操作请参见使用RAM进行访问控制

用户身份

支持情况

阿里云账号

支持

RAM用户(推荐)

支持

RAM角色(推荐)

支持

集成方式

云数据库 Tair(兼容 Redis)提供阿里云SDK、资源编排等多种集成方式,您可以根据业务的实际需要进行选择。

调用方式

支持情况

说明

阿里云SDK(推荐)

阿里云为您提供了多种编程语言(Java、C#、Go、Python、Swift、TypeScript、PHP、C++等)的SDK。SDK屏蔽了OpenAPI实现细节,统一身份、认证及签名规则。您只需要集成SDK,通过SDK直接调用OpenAPI。

支持

云数据库 Tair(兼容 Redis)SDK支持的语言及依赖安装方法请参见云数据库 Tair(兼容 Redis)SDK

阿里云CLI

阿里云CLI命令行工具可以帮您在命令行Shell中,使用aliyun命令与阿里云服务进行交互,管理云服务资源。

支持

您可以在阿里云CLI中输入aliyun r-kvstore <apiName> help查询对应OpenAPI接口所需的参数语法。

Terraform

Terraform是一种开源工具,用于安全高效地预览,配置和管理云基础架构和资源。它与阿里云的资源编排服务的运行机制类似,通过将模板转化为内部数据后完成OpenAPI调用。

支持

云数据库 Tair(兼容 Redis)支持在Terraform中编排、使用的普通资源和数据资源清单,请参见Terraform资源列表(Redis)

资源编排

资源编排服务ROS(Resource Orchestration Service)是阿里云提供的一项简化云计算资源管理的服务。开发者和管理员可以编写模板,在模板中定义所需的阿里云资源(例如:ECS实例、RDS数据库实例)、资源间的依赖关系等。ROS的编排引擎将根据模板自动完成所有资源的创建和配置,实现自动化部署及运维。

支持

云数据库 Tair(兼容 Redis)支持在资源编排服务ROS中调用的普通资源和数据资源清单,请参见资源变配清单(Redis)

若以上方案均无法满足您的业务需要,可自行封装请求调用OpenAPI(不推荐),更多信息请参见V3版本请求体&签名机制

注意事项

如果调用API后返回错误,您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确,更多信息请参见错误码中心

您也可以记录下调用返回的RequestID或SDK报错信息,通过阿里云OpenAPI诊断平台进行自助诊断。

上一篇: 开发参考 下一篇: API参考
阿里云首页 云数据库 Tair(兼容 Redis) 相关技术圈