REST API

记录 Redis Enterprise Software 部署可用的 REST API。

Redis Enterprise Software 提供了 REST API 来帮助您自动执行常见任务。

在这里，您将找到 API 的详细信息及其使用方法。

有关详细信息，请参阅：

• 支持的请求端点（按路径组织）
• 支持的对象，包括请求和响应
• 内置角色和相关权限
• Redis 企业软件 REST API 快速入门及示例

验证

通过Basic Auth对 Redis Enterprise Software API 进行身份验证。提供您的用户名和密码作为基本身份验证凭据。

如果用户名和密码不正确或者丢失，请求将失败并显示401 Unauthorized状态代码。

使用cURL 的示例请求：

curl -u "demo@redislabs.com:password" \
    https://localhost:9443/v1/bdbs

有关更多示例，请参阅Redis Enterprise Software REST API 快速入门。

权限

默认情况下，管理员用户被授权访问所有端点。使用基于角色的访问控制和角色权限来管理访问。

如果用户尝试访问其角色不允许的端点，则请求将失败并显示403 Forbidden状态代码。有关哪些用户角色可以访问特定端点的详细信息，请参阅权限。

证书

Redis Enterprise Software REST API 使用自签名证书来确保产品的安全。使用默认自签名证书时，SSL certificate problem: self signed certificate除非关闭 SSL 证书验证，否则 HTTPS 请求将失败。

端口

所有调用都必须通过 SSL 发送到端口 9443。为了使 API 正常工作，端口 9443 必须暴露给传入流量或映射到其他端口。

如果您使用的是Redis Enterprise Software Docker 映像，请运行以下命令启动 Docker 映像并公开端口 9443：

docker run -p 9443:9443 redislabs/redis

版本

所有 API 请求都经过版本控制，以尽量减少向后不兼容的 API 更改的影响，并协调并行运行的不同版本。

在请求URI中指定版本，如下表所示：

当端点支持多个版本时，每个版本都会记录在相应的端点上。例如，bdbs请求页面记录了版本 1和版本 2 的POST 请求。

标头

请求

Redis Enterprise REST API 请求支持以下 HTTP 标头：

如果客户端指定了无效的标头，则请求将失败并显示400 Bad Request状态代码。

响应

Redis Enterprise REST API 响应支持以下 HTTP 标头：

JSON 请求和响应

Redis Enterprise Software REST API 使用JavaScript 对象表示法 (JSON)进行请求和响应。有关 JSON 的更多信息，请参阅RFC 4627 技术规范。

一些响应可能有一个空的主体，但使用标准HTTP 代码指示响应。

请求和响应都可能包含零个或多个对象。

如果请求针对单个实体，则响应将返回单个 JSON 对象或不返回任何对象。如果请求针对实体列表，则响应将返回包含零个或多个元素的 JSON 数组。

如果您从请求中省略某些 JSON 对象字段，则可能会为它们分配默认值，这通常表明这些字段未被使用。

响应类型和错误代码

HTTP 状态代码指示 API 请求的结果。这可能是200 OK服务器接受请求，也可能是许多错误代码之一。

Redis Enterprise API 请求的最常见响应是：

某些端点会返回不同的响应代码。这些端点的请求参考记录了这些特殊情况。