管理 API 密钥
您可以对已创建的 API 密钥进行管理,包括查看、修改、禁用/激活、删除 API 密钥等。
API 密钥入口
-
登录管理控制台。
-
选择产品与服务 > 访问与授权 > API 密钥,进入 API 密钥页面。
也可以通过将鼠标移动至右上方的用户名,在下拉列表中选择 API 密钥,进入 API 密钥页面。
查看 API 密钥
您可以在 API 密钥列表中查看 API 密钥 ID、密钥名称、状态、描述和创建时间。
修改 API 密钥
您可以修改 API 密钥的属性,包括 API 密钥名称和描述信息。若您需要修改 API 密钥的密钥信息,请删除 API 密钥后再重新创建。
-
在API 密钥页面,勾选需要修改属性的 API 密钥,点击列表上方的更多操作 > 修改。
-
修改完成后,点击提交。
设置 IP 白名单
默认所有 IP 地址都可使用此密钥调用 API,设置 IP 白名单后只有白名单范围内的 IP 地址才可使用此密钥。
-
在API 密钥页面,勾选需要设置 IP 白名单的 API 密钥,点击列表上方的更多操作 > 设置 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 密钥,请执行以下步骤:
-
在API 密钥页面,勾选需要禁用的 API 密钥,点击列表上方的更多操作 > 禁用。
-
在弹出的提示框中,点击确认,禁用 API 密钥。
激活 API 密钥
禁用后,API 密钥状态为暂停
,若需要激活密钥,请执行以下步骤:
-
在API 密钥页面,勾选需要激活的 API 密钥,点击列表上方的更多操作 > 激活。
-
在弹出的提示框中,点击确认,激活 API 密钥。
删除 API 密钥
如果某个 API 密钥出现泄漏风险(比如丢失),建议及时删除该 API 密钥。
注意 |
---|
删除操作无法恢复,为保证业务连续性,建议确认 API 密钥未被业务使用后,再进行删除操作。 |
-
在API 密钥页面,勾选需要删除的 API 密钥,点击列表上方的更多操作 > 删除。
-
在弹出的提示框中,点击确认,删除 API 密钥。