REST API 入门

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

Redis 云

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

要使用密钥对请求进行身份验证和授权，请将密钥包含在请求标头中：

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

启用 API

默认情况下，所有账户都禁用了 API。您必须先启用 API 才能使用它。

当您执行 API 请求时，账户密钥标识您的特定账户。这是负责您的订阅的帐户。

注意：

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

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

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

用户密钥是属于具有 Owner、Viewer 或 Logs viewer 角色的特定用户的个人密钥。用户密钥在创建用户时分配给用户。键只能属于一个用户;但是，一个用户可能有多个密钥。

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

注意：

用户密钥是个人机密。不要分享它们。

各个所有者可以为自己、单独的应用程序或同一账户中的其他所有者、查看者或日志查看者生成多个用户密钥。

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

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

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

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

在以下情况下，API 请求将成功进行身份验证：