タスク認証情報の管理

タスク資格情報は、IBM CloudServices へのリクエストの認証を容易にする、Vault に安全に保管されたユーザー生成 API キーです。 タスク認証情報は、サービス内の特定のタスクを実行したり、スケジュールされたジョブのような長いオペレーションを中断することなく実行できるようにするために使用されます。

IBM watsonxでは、 IBM Cloud API キーがタスク資格情報として使用されます。 既存の IBM Cloud API キーを指定することも、新しいキーを生成することもできます。 IBM Cloudアカウントごとに、1 ユーザーにつき 1 つのタスク・クレデンシャルのみを保存できます。

タスククレデンシャルは、製品のユーザーインターフェースで行うアクションによってトリガーされる、長時間実行される非同期ワークロードで API キーを利用できるようにします。 プログラムで製品を操作する場合は、タスク認証情報を使用しません。

サービスが操作を実行するためにタスククレデンシャルを必要とする場合、APIキー（既存または新規生成）の形でそれを提供するよう促される。

IBM Cloud アカウントを持つすべてのユーザーが API キーを作成できます。 サービス管理者は、タスクのクレデンシャルが不要になった場合にそれを取り消すための戦略を定義する責任を負う。

タスク認証情報へのアクセス

タスク認証情報にアクセスするには

  1. どのエクスペリエンスにもログインした状態で、自分のアバターをクリックし、次にプロフィールと設定をクリックします。

    プロフィールと設定をクリック

  2. User API key タブをクリックします。 キーがあれば表示される。 キーをお持ちでない場合は、作成することができます。

UIからタスクの認証情報を作成する

新しいタスク認証情報を作成する：

プロフィールの［ User API key］ タブで、［ Create a key ］をクリックします：

API キーの作成

新しいAPIキーがキーリストに表示されます。

タスク認証情報をプログラムで作成する

REST API 呼び出しでタスクのクレデンシャルを作成できます。 アクセスが必要な各データセンターで、以下のタスクを繰り返してください。 詳細は、APIリファレンス watsonx.ai ドキュメントのエンドポイントURL を参照してください。

シナリオ1：既存のサービスIDのタスク認証情報の作成

serviceIDs, を使っている場合、UI Path を使ってタスクのクレデンシャルを作成することはできない。 指定された serviceID のタスク・クレデンシャルを作成するには、 cURL リクエストを実行する必要がある。 この資格情報は、 デプロイメント、 デプロイメント・ジョブ作成、およびその他の関連操作に使用されます。

  1. サービスID APIキー用のアクセス トークンを作成します:

    API_KEY="<Your service ID API key>"
ACCESS_TOKEN=$(curl -X POST "https://iam.cloud.ibm.com/identity/token?grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=${API_KEY}" | jq -r .access_token)

  2. タスク・クレデンシャルを作成する：

    curl -X POST "https://<Cloud provider endpoint URL>/v1/task_credentials" \
  -H "accept: application/json" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "SERVICE_ID_TASK_CREDENTIALS",
    "type": "iam_api_key",
    "secret": {
      "api_key": ${API_KEY}
    }
  }'

タスク認証情報を作成した後、失敗したジョブまたはデプロイメント再トリガーする前に15～20分待ちます（予防措置）。

シナリオ2：通常ユーザー用のタスク認証情報の作成（APIを使用）

UIにアクセスできない場合、プログラムでタスクのクレデンシャルを作成することができます。

  1. APIキーをお持ちでない場合は、作成する必要があります。 タスク資格情報の作成 」を参照してください。 次に、APIキーのアクセス トークンを以下のように作成できます:

    API_KEY="<Your API key>"
ACCESS_TOKEN=$(curl -X POST "https://iam.cloud.ibm.com/identity/token?grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=${API_KEY}" | jq -r .access_token)

  2. タスク・クレデンシャルを作成する：

    curl -X POST "https://<Cloud provider endpoint URL>/v1/task_credentials" \
  -H "accept: application/json" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "USER_TASK_CREDENTIALS",
    "type": "iam_api_key",
    "secret": {
      "api_key": ${API_KEY}
    }
  }'

既存のタスク資格情報の管理

キーを再作成するには、[User API key]タブから[Rotate key]をクリックします。 新しいAPIキーがキーリストに表示されます。

キーを削除するには、 「ユーザー API キー 」タブで「削除」アイコンをクリックしてください。 削除アイコン

詳細情報