用户可以对已创建的 API 密钥进行管理,包括修改、禁用/激活、删除 API 密钥等。

修改 API 密钥

用户可以修改 API 密钥的属性,包括 API 密钥名称和描述信息。若用户需要修改 API 密钥的密钥信息,请删除 API 密钥后再重新创建。

  1. 登录控制台。

  2. 点击顶部导航用户名称 > API 密钥,进入 API 密钥列表页面。

  3. API 密钥页面,勾选需要修改属性的 API 密钥,点击列表上方的更多操作 > 修改

    secret key mgt 1
  4. 修改完成后,点击提交

设置 IP 白名单

默认所有 IP 地址都可使用此密钥调用 API,设置 IP 白名单后只有白名单范围内的 IP 地址才可使用此密钥。

  1. API 密钥页面,勾选需要设置 IP 白名单的 API 密钥,点击列表上方的更多操作 > 设置 IP 白名单

  2. 在弹出的设置 API 密钥 IP 白名单窗口中,输入 IP 地址,点击提交即可。

    说明

    白名单支持三种格式:IP 地址、IP 段和 IP 地址范围。多个 IP 请使用换行符进行分隔,例如:

    192.168.1.1
    192.168.2.0/24
    192.168.3.1-192.168.3.7

禁用 API 密钥

新创建的 API 密钥默认为活跃状态,若需要禁用 API 密钥,请执行以下步骤:

  1. API 密钥页面,勾选需要禁用的 API 密钥,点击列表上方的更多操作 > 禁用

  2. 在弹出的提示框中,点击确认,禁用 API 密钥。

激活 API 密钥

禁用后,API 密钥状态为暂停,若需要激活密钥,请执行以下步骤:

  1. API 密钥页面,勾选需要激活的 API 密钥,点击列表上方的更多操作 > 激活

  2. 在弹出的提示框中,点击确认,激活 API 密钥。

删除 API 密钥

如果某个 API 密钥出现泄漏风险(比如丢失),建议及时删除该 API 密钥。

注意

删除操作无法恢复,为保证业务连续性,建议确认 API 密钥未被业务使用后,再进行删除操作。

  1. API 密钥页面,勾选需要删除的 API 密钥,点击列表上方的更多操作 > 删除

  2. 在弹出的提示框中,点击确认,删除 API 密钥。