この文書は自動機械翻訳技術を使用して翻訳されています。 正確な翻訳を提供するように努めておりますが、翻訳された内容の完全性、正確性、信頼性については一切保証いたしません。 相違がある場合は、元の英語版 英語 が優先され、正式なテキストとなります。

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 にアクセスする前に、Rancher との認証に使用されるキーをアプリに提供する必要があります。Rancher UI を使用してキーを取得できます。

Rancher CLI を使用するには API キーも必要です。

API キーは四つのコンポーネントで構成されています：

  • *エンドポイント:*これは、他のアプリケーションが Rancher API にリクエストを送信するために使用する IP アドレスとパスです。

  • *アクセスキー:*トークンのユーザー名。

  • *シークレットキー:*トークンのパスワード。API 認証のために二つの異なる文字列を要求するアプリでは、通常、二つのキーを一緒に入力します。

  • *ベアラートークン:*トークンのユーザー名とパスワードを連結したもの。一つの認証文字列を要求するアプリにはこの文字列を使用してください。

ユーザーは トークンハッシング を有効にすることを選択できます。

API キーの作成

  1. 右上隅から ユーザーアバター  アカウント & API キー を選択します。

  2. API キーを作成 をクリックします。

  3. *オプション:*API キーの説明を入力し、期限またはスコープを選択します。有効期限を設定することをお勧めします。

    API キーは有効期限後は無効になります。短い有効期限はより安全です。

    有効期限は`v3/settings/auth-token-max-ttl-minutes`によって制約されます。最大TTLを超えると、APIキーは最大TTLを有効期限として作成されます。

    スコープはAPIキーを制限し、指定されたクラスターのKubernetes APIに対してのみ機能します。クラスターが認可されたクラスターエンドポイントで構成されている場合、Rancherサーバーを介さずにクラスターのAPIに対してスコープ付きトークンを直接使用できます。詳細については、認可されたクラスターエンドポイントを参照してください。

  4. ［作成］をクリックします。

    ステップ結果:*あなたのAPIキーが作成されました。あなたのAPI *エンドポイント、アクセスキー、シークレットキー、および*ベアラートークン*が表示されます。

    *ベアラートークン*を使用してRancher CLIで認証します。

  5. 表示された情報を安全な場所にコピーしてください。この情報は一度だけ表示されるため、キーを失うと新しいものを作成する必要があります。

次は何ですか？

  • Rancher APIにリクエストを送信するアプリケーションにAPIキー情報を入力してください。

  • Rancher UIのオブジェクトに対して*APIで表示*を選択することで、Rancherエンドポイントとパラメータについて詳しく学ぶことができます。

  • APIキーはAPI呼び出しとRancher CLIに使用されます。

APIキーの削除

APIキーを取り消す必要がある場合は、それを削除してください。APIキーは次の場合に削除するべきです：

  • それが侵害された可能性がある場合。

  • それが期限切れになった場合。

APIを削除するには、古くなったキーを選択し、*削除*をクリックしてください。