管理 API 密钥

如何使用 Redis Cloud 控制台为账户的团队所有者创建和管理 API 用户密钥

每个 REST API 请求都必须包含以下 API 密钥：

1. Account key （帐户密钥） 标识与 Redis Cloud 订阅关联的帐户。

2. User key 标识用户和（可选）请求的上下文。由账户所有者生成。

使用 Access Management （访问管理） 屏幕的 API Keys （API 密钥） 选项卡管理您的密钥：

1. 以账户所有者身份登录您的 Redis Cloud 账户。

2. 从菜单中，选择 Access Management （访问管理），然后选择 API 密钥 （API Keys） 选项卡。

   

如果出现 Enable API （启用 API） 按钮，请选择它以为您的账户启用 REST API。

API 帐户密钥

API account key 用作x-api-keyHTTP 标头，以便对 REST API 请求进行身份验证。

默认情况下，API 账户密钥被屏蔽;也就是说，出于安全原因，它被遮挡了。您可以使用 Show 按钮显示键，使用 Hide 按钮对其进行遮罩。

Copy （复制） 按钮将帐户密钥复制到剪贴板。

API 用户密钥

API 用户密钥（也称为 Secret 密钥）用作x-api-secret-key用于验证 REST API 请求的 HTTP 标头。

在此上下文中，user 是指用于登录 Redis Cloud 控制台的帐户。用户必须具有所有者 （读写） 或 查看者 （只读） 角色。

用户可以拥有多个用户密钥;但是，用户不应共享用户密钥。

创建新的用户密钥

使用 Add （添加） 按钮创建新的用户密钥。

执行此作时，系统会提示您输入 Key name （密钥名称） 和关联的 User name （用户名）。

密钥名称：

• 长度必须介于 10 到 50 个字符之间
• 可以包含字母数字字符、连字符和下划线。不允许使用空格。

所选用户必须具有所有者、查看者或日志查看者角色。

选择 Create 以创建新密钥。

执行此作时，将显示 API user key （API 用户密钥） 对话框。

保存用户密钥后，使用 Finish 按钮关闭对话框。

（在将键复制到剪贴板之前，Finish 按钮处于禁用状态。

删除用户密钥

要删除用户密钥：

1. 使用 Access Management 屏幕的 API Keys 选项卡查找目标密钥

   
   

2. 选择右侧显示的 Delete 按钮。

   

3. 这将显示 Delete API secret key （删除 API 密钥） 对话框。

   
   

   选择 Delete 按钮进行确认。

管理 CIDR 允许列表

默认情况下，允许来自所有 IP 地址的 REST API 请求。要限制对特定地址的访问，请为用户密钥定义 CIDR 允许列表。

要管理 CIDR 允许列表，请执行以下作：

1. 使用 Access Management 屏幕的 API Keys 选项卡查找目标密钥

   

2. 选择 CIDR 允许列表列中的 Manage 链接;这将显示 Manage CIDR allow list （管理 CIDR 允许列表） 对话框。

   

3. 以 CIDR 格式输入每个允许的 IP 地址（例如：127.1.0.0/24），然后选择 Save 按钮。

   

   使用 Add CIDR rule （添加 CIDR 规则） 按钮将其他地址添加到列表中。

   

   使用 Edit 按钮更改规则的地址，或使用 Delete 按钮删除规则。