云数据库Redis提供丰富的OpenAPI(简称API)接口,您可以通过在线、编程或命令行等方式调用,实现云资源的便捷管理。组合使用各类云产品的API,更可实现复杂的定制功能。

注意事项

本文介绍的API仅用于管理云数据库Redis实例,如需对实例中的数据执行读写操作,请使用Redis-API(即Redis的命令)。更多信息,请参见Redis命令支持概览

说明 云数据库Redis支持多种程序开发语言,您可以使用封装了Redis-API的SDK来开发的应用程序,更多信息,请参见Redis-SDK

什么是API

API(Application Programming Interface)即应用程序编程接口。云数据库Redis的API为您提供管理云资源的能力,您无需访问深入理解源码或内部工作机制即可快速上手,极大降低使用门槛。关于云数据库Redis支持的API,请参见API概览

请求结构与返回结果

类别 说明
请求结构 云数据库Redis提供的API基于URL发起HTTP或HTTPS GET请求,您需要按照接口说明在请求中加入相应的请求参数,调用后系统会返回处理结果。
返回结果 API的返回结果采用XML和JSON两种数据格式,您可以在请求时传入参数来指定返回的数据格式,默认为XML格式。

如何调用API

调用方法 说明 适用场景
通过OpenAPI开发者门户在线调用API OpenAPI开发者门户提供可视化的API调用工具,可提供动态生成SDK示例代码和快速检索接口等功能,能显著降低使用API的难度,帮助您快速使用阿里云API。
  • 在线调用管理云资源
  • 动态生成SDK示例
通过SDK调用API(Java) 阿里云提供的开发者工具套件(Alibaba Cloud SDK),可支持Java、Python等多种语言,您无需操作复杂的编程、无需计算复杂的签名及公共参数,即可快速调用云产品的API接口。
  • 通过编程批量管理云资源
  • 开发程序实现定制功能
通过阿里云CLI调用API 阿里云命令行工具是在Alibaba Cloud SDK for Go之上构建的开源工具,可通命令行与阿里云服务进行交互,管理您的阿里云资源。
  • 通过命令行批量管理云资源
  • 开发Shell脚本实现定制功能

排查报错问题

如果调用API后返回错误,您需要根据返回的错误码提示检查传入的请求参数及其取值是否正确。更多信息,请参见错误码中心,您也可以记录下调用返回的RequestID或SDK报错信息,通过阿里云OpenAPI诊断平台进行自助诊断