こんにちは、Cloud Automator の山田です。
今回のブログは、先月リリースした REST API の機能追加に関するお知らせです。
※ Cloud Automator の REST API については こちらの記事 をご参照ください。
REST API が後処理に対応しました！
以前までは Cloud Automator の REST API では「AWSアカウント」「ジョブ」「ジョブのログ」のみ操作することができましたが、今回のリリースによって「後処理」も REST API 経由で操作することができるようになりました！
※ REST APIのドキュメントは こちらのページ で公開しております。
REST API で後処理を作成する
それでは早速、REST API で後処理を作成してみたいと思います。
1. API キーの発行
Cloud AutomatorのREST APIをご利用頂く場合、認証のためにAPIキーが必要になります。
グローバルメニューのアカウントより、アカウント設定画面にアクセスして、APIキーの設定から「作成する」をクリックします。
※ 既に API キーを発行済の方は「表示する」をクリックします。
表示されたAPIキーをメモしたら、「戻る」をクリックします
2. REST API で後処理を登録
以下のように、後処理を登録します。
※ 以下は test-post-process という名前で サービスタイプが email で メールの送信先が hoge@test.com の後処理を登録する例です。
$ curl -X POST https://manager.cloudautomator.com/api/v1/post_processes \
-H "Content-Type: application/json" -H "Authorization: Bearer ********************************" \
-d '{"name":"test-post-process", "service":"email", "parameters": {"email_recipient": "hoge@test.com"}}'
後処理の作成に成功すると、作成した後処理の情報を含むレスポンスが返ってくるはずです。
{"data":{"id":"130","type":"post_processes","attributes":{"name":"test-post-process","service":"email","parameters":{"recipients":["hoge@test.com"]},"created_at":"2017-08-14Txx:xx:xx.xxx+09:00","updated_at":"2017-08-14Txx:xx:xx.xxx+09:00"}}}
これで後処理は作成完了です。
3. ジョブに後処理を登録
続いて、ジョブに後処理を登録します。
※ 以下は、ID: 130 の後処理を ID:100 のジョブに登録する例です。
curl -X PATCH https://manager.cloudautomator.com/api/v1/jobs/100 \
-H "Content-Type: application/json" -H "Authorization: Bearer ********************************" \
-d '{"completed_post_process_id": [130]}'
ジョブに後処理が登録されると、以下のようなレスポンスが返ってくるはずです。
{"data":{"id":"100","type":"trigger_jobs","attributes":{"name":"test-job","aws_account_id":xxx,"rule_type":"cron","rule_value":{"hour":"8","minutes":"0","time_zone":"Tokyo","schedule_type":"weekly","next_occurrence":"xxxx-xx-xx xx:xx:xx UTC","weekly_schedule":"[\"\", \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\"]"},"action_type":"start_instances","action_value":{"region":"ap-northeast-1","tag_key":"xx","tag_value":"xx","trace_status":"true","specify_instance":"tag"},"active":true,"created_at":"xxxx-xx-xxTxx:xx:xx.xxx+09:00","updated_at":"xxxx-xx-xxTxx:xx:xx.xxx+09:00"}}}
終わりに
今回は 8月14日にリリース致しました REST API の後処理対応に関してお知らせしました。
これからも Cloud Automator をよろしくお願い致します。
Cloud Automator(クラウドオートメーター)とは、ノンプログラミングでAWS運用を自動化し、AWSの利用を最大限に引き出すサービスです。バックアップや災害対策、AWS費用の削減を実現する「ジョブ」と、AWSがガイドライン通りに運用されていることを継続的に確認する「構成レビュー」という2つの機能をご提供しております。
