Oracle Cloud Infrastructureドキュメント

作業リクエスト

このトピックでは、「作業リクエストAPI」に記述されている作業リクエストの機能について説明します。 次のOracle Cloud Infrastructureサービスは、このAPIと統合されています:

ノート

一部のOracle Cloud Infrastructureサービスには、このトピックで説明する作業リクエストAPIではなく、サービスAPIでサポートされている作業リクエストが用意されています。 これらのサービスの作業リクエストの詳細は、次のトピックを参照してください:

作業リクエストを使用すると、「データベース」バックアップや「コンピュート」インスタンスのプロビジョニングなど、長時間実行されている操作を監視できます。 このような操作を開始すると、サービスは「作業リクエスト」を生成します。 作業リクエストとは、操作の進行中に各ステップを追跡できるアクティビティ・ログです。 各作業リクエストには、プログラムで対話して自動化に使用できるOCIDがあります。

操作が失敗した場合、作業リクエストは、プロセスのどのステップでエラーが発生したかを判断するのに役立ちます。

一部の操作は複数のリソースに影響します。 たとえば、インスタンス・プールの作成は、インスタンスおよびインスタンスの構成にも影響を与えます。 作業リクエストでは、操作が影響するリソースのリストが提供されます。

順次操作が必要なワークフローの場合は、各操作の作業リクエストをモニターし、次の操作に進む前に、操作が完了していることを確認できます。 たとえば、自動スケーリングを有効化したインスタンス・プールを作成するとします。 これを行うには、まずインスタンス・プールを作成し、次に自動スケーリングを構成する必要があります。 インスタンス・プールを作成するための作業リクエストをモニターして、ワークフローが完了した時間を確認し、完了後に自動スケーリングを構成できます。

作業リクエストは12時間保持されます。

必要なIAMポリシー

Oracle Cloud Infrastructureを使用するには、管理者が作成するポリシーで、コンソールまたはSDK、CLIまたはその他のツールを使用したREST APIのどちらを使用しているかにかかわらず、必要なタイプのアクセスを付与する必要があります。 アクションを実行しようとしたときに、権限のないメッセージや権限のないメッセージを取得する場合は、管理者に付与されているアクセスのタイプと作業するコンパートメントを確認してください。

管理者向け: 作業リクエストは、作業リクエストを生成する操作の権限を継承します。 操作の作業リクエスト、ログおよびエラー・メッセージをユーザーが表示できるようにするには、操作の実行権限をユーザーに付与するポリシーを記述します。 たとえば、インスタンスの起動に関連する作業リクエストをユーザーに表示するには、ユーザーがインスタンスを起動できるようにするポリシーを記述します。

テナンシのすべての作業リクエストをユーザーがリストできるようにするには、次のポリシーを使用します:

Allow group SupportTeam to inspect work-requests in tenancy

新しいポリシーの場合は、「ポリシーの開始」「共通ポリシー」を参照してください。

作業リクエストの状態

注意: 一部のサービスまたは操作の作業リクエストでは、次のステータスのサブセットのみがサポートされます。

受入済
リクエストは処理される作業リクエスト・キューにあります。
in_progress
指定されたリクエストに対して作業リクエスト・レコードが存在しますが、関連するWORK_COMPLETEDレコードはありません。
成功済
このリクエストに対する作業リクエスト・レコードが存在し、関連するWORK_COMPLETEDレコードの状態はSUCCEEDEDです。
失敗
このリクエストに対して作業リクエスト・レコードが存在し、関連するWORK_COMPLETEDレコードにはFAILED状態があります。
取消中
作業リクエストは取消中です。
取消済
作業リクエストは取り消されました。

コンソールを使用した作業リクエストの表示

作業リクエストを表示するステップは、作業リクエストをサポートするOracle Cloud Infrastructureサービスの場合と同様です。

  1. 作業リクエストを表示するリソースにナビゲートします。

    たとえば、「コンピュート」インスタンスの作業リクエストを表示するには: 「ナビゲーション・メニュー」を開きます。 コア・インフラストラクチャの下で、コンピュートに移動して「インスタンス」をクリックします。

  2. リソースがリスト表示に表示される場合は、リソース名をクリックしてリソースの詳細を表示します。
  3. 詳細ページの「リソース」セクションで、「作業リクエスト」をクリックします。 すべての作業リクエストのステータスがページに表示されます。
  4. 特定の作業リクエストに関連付けられたログ・メッセージ、エラー・メッセージおよびリソースを表示するには、操作名をクリックします。 次に、「詳細情報」セクションでオプションを選択します。

    関連付けられているリソースの場合は、リソースの横にあるアクション・アイコン(3ドット)をクリックして、リソースOCIDをコピーできます。

APIの使用

APIおよび署名リクエストの使用については、REST APIおよび「セキュリティ資格証明」を参照してください。 SDKの詳細は、「ソフトウェア開発キットとコマンドライン・インタフェース」を参照してください。

作業リクエストの状態を監視するには、次のAPI操作を使用します: