ジョブに設定された後処理の情報をAPIで取得できますか?

取得できます。

Cloud Automator APIの Get Job(またはGet Jobs)を使用して、ジョブに設定された「成功時の後処理」と「失敗時の後処理」のIDを取得できます。 
取得したIDをもとに Get PostProcess を実行することで、後処理の詳細情報を確認することができます。

Cloud Automator APIの用方法については、Cloud Automator APIの利用方法(マニュアル)をご参照ください。

情報を取得するまでの流れ

ジョブに設定された後処理の情報を取得するには、以下の手順で操作します。

  1. Get Job(またはGet Jobs)APIを実行して、ジョブの情報を取得します
  2. レスポンスに含まれる completed_post_process_id(成功時の後処理IDの配列)および failed_post_process_id(失敗時の後処理IDの配列)を確認します
  3. 取得した後処理IDを使用して、Get PostProcess APIを実行します
  4. 後処理名・サービスの種類・設定パラメーターなどの詳細情報を確認します

サンプル

STEP1: Get Job でジョブの後処理IDを取得する

  • ジョブIDを指定してGet Job APIを実行し、後処理IDを含むジョブ情報を取得します。{ジョブID} には対象のジョブのIDを指定してください。
$ curl "https://manager.cloudautomator.com/api/v1/jobs/{ジョブID}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {APIキー}"

レスポンス例(主要項目を抜粋して記載しています):

{
  "data": {
    "id": "1",
    "type": "trigger_jobs",
    "attributes": {
      "name": "毎週月曜の9時にAMIを作成",
      "completed_post_process_id": [1],
      "failed_post_process_id": [2]
    }
  }
}

上記の例では、成功時の後処理IDが 1、失敗時の後処理IDが 2 に設定されています。

completed_post_process_id および failed_post_process_id は配列形式で返されます。後処理が複数設定されている場合は、複数のIDが含まれます。


STEP2: Get PostProcess で後処理の詳細を取得する

  • STEP1 で取得した後処理IDを使用してGet PostProcess APIを実行し、後処理の詳細情報を取得します。
    • {後処理ID} には対象の後処理IDを指定してください。
    • 後処理が複数設定されている場合は、IDごとに実行します。
$ curl "https://manager.cloudautomator.com/api/v1/post_processes/{後処理ID}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {APIキー}"

レスポンス例:

{
  "data": {
    "id": "1",
    "type": "post_processes",
    "attributes": {
      "name": "後処理名",
      "service": "email",
      "group_id": 1,
      "shared_by_group": false,
      "parameters": {
        "email_recipient": "example@example.com"
      },
      "created_at": "2016-10-13 22:45:45 +0900",
      "updated_at": "2016-10-13 22:45:45 +0900"
    }
  }
}

以上、Cloud Automator APIを使用してジョブに設定された後処理の情報を取得する方法をご紹介しました。
ジョブ移行などの際にAPIを活用することで、後処理の設定を効率よく確認できますので、ぜひご活用ください。

関連

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています
他にご質問がございましたら、リクエストを送信してください