メイン コンテンツをスキップする 補完的コンテンツへスキップ

メンテナンスウィンドウでタスクを一時停止

メンテナンスウィンドウの間、部分的な実行やデータの完全性に関する問題を回避するよう、タスクを一時停止します。

この例では、デモンストレーションを目的として1つのタスクのみ使用しています。自分のスクリプトを使用して、一時停止が必要なタスクをすべて一時停止させるリクエストをループさせることができます。

始める前に

  • TMCトークンを生成:

    生成されたサービスアカウントトークンは30分後に期限切れになります。期限切れになった場合は、エンドポイントhttps://api.<env>.cloud.talend.com/security/oauth/tokenでPOSTメソッドを使って新しいトークンを生成します。トークンの生成に関する詳細は、サービスアカウントトークンを生成をご覧ください。

  • 検証するタスクが属するワークスペースで、APIコールの発行に使用するユーザーまたはサービスアカウントがTMC_OPERATORロールとAUTHOR権限を持っていること。

手順

次のリクエストを発行して、指定されたタスクを一時停止します。

例

method: PUT
                  endpoint: https://api.<env>.cloud.talend.com/orchestration/executables/tasks/<taskId>/pause
headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer <your_personal_access_token_or_service_account_token>"
          }
payload: {
      "pause" : true,
      "pauseContext" : "Pause during the maintenance window"
         }
  • タスクを一時停止するよう、pauseフィールドにtrueと設定します。
  • pauseContextフィールドに、タスクを一時停止する理由を説明するメッセージを入力します。
スケジュールされたタスク実行をすべて取得するために使われた前のAPIリクエストでアクセストークンが設定されているため、Talend API Testerを使ってリクエストを発行する場合は、その[Expression Builder] (式ビルダー)で呼び出しの[Authorization] (承認)フィールドを再利用できます。たとえば、[Expression Builder] (式ビルダー)メニューで、選択したリポジトリーの式設定に認可フィールドを追加します。

式ビルダーの詳細は、式を使用をご覧ください。

タスクの結果

202コードが返され、この停止は直ちに有効となります。そのため、メンテナンスが開始する場合のみリクエストを送信します。

次のタスク

メンテナンスが終了したら、タスクを再開します。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。

こちらにフィードバックをお寄せください