本文档采用自动化机器翻译技术翻译。 尽管我们力求提供准确的译文，但不对翻译内容的完整性、准确性或可靠性作出任何保证。 若出现任何内容不一致情况，请以原始 英文 版本为准，且原始英文版本为权威文本。

API 词元

Deprecation of v3 API tokens

Rancher v2.13 introduced a new token resource in the ext.cattle.io API group to serve as the public API for tokens, which was only accessible through kubectl.

Starting with Rancher v2.14.1:

  • Legacy v3 API tokens (tokens.management.cattle.io) are being phased out and scheduled for removal in a future release. If you currently rely on legacy tokens for automation or API access, transition to the new tokens.ext.cattle.io tokens to ensure continued compatibility.

  • The Rancher dashboard provides basic support for tokens.ext.cattle.io (create, view or list, and delete).

API 密钥和用户认证

如果您想使用外部应用程序访问您的 Rancher 集群、项目或其他对象，可以通过 Rancher API 实现。但是，在您的应用程序可以访问 API 之前，您必须为 APP 提供一个用于与 Rancher 进行身份验证的密钥。您可以通过 Rancher UI 获取密钥。

使用 Rancher CLI 也需要 API 密钥。

API 密钥由四个组成部分构成：

  • *端点：*这是其他应用程序用来向 Rancher API 发送请求的 IP 地址和路径。

  • *访问密钥：*词元的用户名。

  • *机密密钥：*词元的密码。对于提示您输入两个不同字符串进行 API 认证的应用程序，通常需要将两个密钥一起输入。

  • *Bearer Token:*词元的用户名和密码连接在一起。对于提示您输入一个认证字符串的应用程序，请使用此字符串。

用户可以选择启用 词元哈希。

创建 API 密钥

  1. 从右上角选择 用户头像  账户与 API 密钥。

  2. 点击 创建 API 密钥。

  3. *可选：*输入 API 密钥的描述，并选择一个过期时间或作用域。我们建议设置一个过期日期。

    API 密钥在过期后将无效。较短的过期时间更安全。

    过期时间受限于`v3/settings/auth-token-max-ttl-minutes`。如果超过最大生存时间，API 密钥将以最大生存时间作为过期时间创建。

    作用域限制 API 密钥，使其仅对指定集群的 Kubernetes API 有效。如果集群配置了授权集群端点，您可以直接使用作用域令牌访问集群的 API，而无需通过 Rancher 服务器代理。有关更多信息，请参见 授权集群端点。

  4. 单击*创建*。

    步骤结果:*您的 API 密钥已创建。您的 API *端点、访问密钥、秘密密钥 和 承载词元 已显示。

    使用 承载词元 通过 Rancher CLI 进行身份验证。

  5. 将显示的信息复制到安全位置。此信息仅显示一次，因此如果您丢失密钥，您将需要重新生成一个。

下一步怎么办？

  • 将您的 API 密钥信息输入到发送请求到 Rancher API 的应用程序中。

  • 通过在 Rancher UI 中选择 在 API 中查看 来了解有关 Rancher 端点和参数的更多信息。

  • API 密钥用于 API 调用和 Rancher CLI。

删除 API 密钥

如果您需要撤销 API 密钥，请删除它。您应该删除 API 密钥：

  • 可能已被泄露。

  • 已过期。

要删除 API 密钥，请选择失效密钥并点击*删除*。