外部連携機能とは
外部連携機能は、外部サービス(サードパーティ製モニタリングツール)のWebhookイベントをトリガとして、AppKeeperの復旧機能を利用できるサービスです。
外部連携機能では、外部サービスからのWebhook通知(HTTPリクエスト)を受け取って、AppKeeperの機能を実行するためのREST APIを提供します。
また、APIの認証で用いるトークンを生成をする機能を提供します。
外部サービスにAPIのURLとトークンを登録することによって、外部サービスと連携してAppKeeperの機能を実行することができます。
本ドキュメントでは、API仕様と、APIトークンの発行方法を説明します。
前提
外部連携機能を使用できる条件は以下の通りです。
- AWSアカウントがAppKeeperのテナントに登録済みである
- 対象のインスタンスがAppKeeperによって検出済みである
- 対象のインスタンスの監視設定がOnになっている
- AppKeeperの監視ステータスが「起動中」である
これらの条件を満たしていない場合、APIのレスポンスは404(Bad Request)エラーになります。
外部連携用APIの使用方法
APIトークン取得
- AppKeeperのGUIにログインし、[アカウント情報]ボタンをクリックします。
- アカウント情報画面で、[トークンの取得]ボタンをクリックします。
API仕様
APIの仕様以下の通りです。
- 復旧機能
URL |
https://api.appkeeper.sios.com/v2/integration/{AWSアカウントID}/actions/recover |
Method |
POST |
Header |
appkeeper-integration-token: <APIトークン> |
Request Body |
{ |
呼び出しの例
curl:
curl -X POST https://api.appkeeper.sios.com/v2/integration/{AWSアカウントID}/actions/recover -H 'appkeeper-integration-token: <APIトークン>' -d '{ "instanceId": "<インスタンスID>", "name": "<サービス名>"}'
注意事項
トークンには有効期限がありません。このため、外部に漏洩しないよう厳重な管理をお願いします。万が一漏洩した場合には、AppKeeperのGUIより以下の手順でトークンの無効化を行ってください。
- AppKeeperのGUIにログインし、[アカウント情報]ボタンをクリックします。
- アカウント情報画面で、[トークンを無効化する]ボタンをクリックします。
トークンの最終更新日が更新され、それ以前に取得したトークンは全て無効になります。
コメント
0件のコメント
サインインしてコメントを残してください。