开始使用 REST API

描述 Redis Cloud REST API 如何使用密钥进行身份验证和授权访问。

要使用 Redis Cloud REST API，您需要：

要使用密钥来验证和授权您的请求，请将密钥包含在请求标头中：

键名称	HTTP 标头名称	描述
帐户密钥	`x-api-key`	分配给帐户所有用户的帐户级密钥
用户密钥	`x-api-secret-key`	与特定用户相关联的个人密钥，可能仅限于某些 IP 范围

启用 API

默认情况下，所有帐户均禁用该 API。您必须先启用该 API，然后才能使用它。

帐户密钥用于在您执行 API 请求时识别您的特定帐户。这是负责您订阅的帐户。

笔记：

帐户密钥是帐户级机密。请勿与任何未经授权使用该帐户的人共享此密钥。

启用 API 访问时，您需要创建一次帐户密钥。

如果您需要更改或删除您的帐户密钥，请联系支持人员。

用户密钥是属于具有所有者角色的特定用户的个人密钥。用户密钥在创建时会被指定所有者。密钥不能分配给非所有者的用户。密钥只能属于一个所有者；但是，一个所有者可以拥有多个密钥。

您只能在创建过程中查看键或复制其值。

笔记：

用户密钥属于个人秘密。请勿分享。

个人所有者可以为自己、不同的应用程序或同一帐户内的其他所有者生成多个用户密钥。

使用键名将特定 API 请求与单个用户或应用程序唯一关联。

这样做可以让您使用系统日志审核 API 请求，系统日志会跟踪用于验证每个请求的密钥。

每个 API 请求都必须使用账户密钥和用户密钥进行身份验证。

如前所示，密钥以HTTP 请求标头的形式提供。

在以下情况下，API 请求验证成功：