メインコンテンツまでスキップ

APIアラート受信機能

APIアラート受信機能の概要​

APIアラート受信機能は、アラート送信APIを利用してAMCにアラートを送信する機能です。 アラート送信APIを利用して送信したアラート情報は、メールでのアラート送信と同様に扱われ、同じパターンが適用されます。

アラート送信API仕様​

URL​

https://api.amc.masterscope.jp/alerts

メソッド​

POST

リクエストヘッダ​

パラメータ値説明
Content-Typeapplication/jsonサポートするデータ形式はJSONだけです。
x-api-keyAPIキープロジェクト毎に発行されるAPIキーを指定します。APIキーはプロジェクト管理画面で発行できます。
User-AgentUser-Agent送信元プログラム名。値は任意ですが設定が必須です。

リクエストボディ​

下記のアラート情報をUTF-8でエンコードされたJSON形式で指定してください。 指定されたアラート情報を基にパターンマッチやプロジェクトのアラート受信許可の判定が行われます。

パラメータ名必須説明
pj_id〇プロジェクトIDを指定してください。プロジェクトIDはプロジェクト管理のプロジェクト詳細画面で参照できます。PJコードではありません。
subject×アラートの件名。メール通報におけるメール件名と同じように扱われます。
body×アラートの本文。メール通報におけるメール本文と同じように扱われます。本文中で改行する場合はLF(\n)を挿入してください。
from_address×送信元名称。メール通報におけるFromアドレスと同じように扱われます。

レスポンス​

ステータスコードとJSON形式のメッセージを返します。

レスポンスボディの形式​

{
    "message" : "OK"
}

ステータスコードとメッセージの一覧​

ステータスコードメッセージ説明
200OK
400Rest API alert reception setting is disabledAPIアラート受信が無効です。
400Invalid content typeContent-Typeが不正です。
400There is no headerリクエストヘッダが指定されていません。
400There is no bodyリクエストボディが指定されていません。
400Invalid request bodyリクエストボディがJSON形式ではありません。
400Parameter: <パラメータ名> is not stringパラメータに文字列以外が指定されています。
400Parameter: <パラメータ名> contains invalid charactersパラメータに使用できない文字が含まれています。
400Parameter: pj_id is requiredパラメータpj_idが指定されていません。
400Parameter: pj_id is not a valid uuid formatパラメータpj_idがUUID形式ではありません。
400Parameter: <パラメータ名> exceeds max length of <最大長><パラメータ名>の長さが<最大長>を超過しています。
400Api key is invalid in the projectAPIキーがパラメータpj_idに指定したプロジェクトのものではありません。
403Invalid API key指定されたAPIキーは無効です。
403Forbiddenリクエストがブロックされました。
413Payload Too Largeリクエストのサイズが大きすぎます。
429Too Many Requests単位時間あたりのリクエスト数が多すぎます。しばらく時間をおいてから再度お試しください。
429Rate exceededサーバが高負荷のため処理ができませんでした。しばらく時間をおいてから再度お試しください。
500/502Internal Server Errorサーバ内部エラーが発生しました。
504Gateway Timeoutリクエストに対する処理がタイムアウトしました。
info

サーバ側の処理負荷が高く処理を行えなかった場合、ステータスコードの429や500番台が返ることがあります。1分以上あけてから再度実行してください。

実行例​

以下はcurlコマンドを使用してAPIを実行する例です。

Linuxの場合​

実行コマンド例

curl -X POST -H 'x-api-key:XXX' -H 'Content-Type: application/json' \
 -d '{"pj_id": "XXX", "subject": "アラート件名", "body": "アラート本文"}' \
 https://api.amc.masterscope.jp/alerts -w ' : %{http_code}\n'

Windowsの場合​

Windowsのcurlコマンドで実施する場合は送信するリクエストボディの内容をファイルにUTF-8形式で保存を行い、ファイルを指定してください。 コマンドプロンプトで直接文字列を指定するとUTF-8形式とならず文字化けの原因となります。

body.json

{"pj_id": "XXX", "subject": "アラート件名", "body": "アラート本文"}

実行コマンド例

curl -X POST -H "x-api-key:xxx" -H "Content-Type: application/json" -d @body.json https://api.amc.masterscope.jp/alerts -w " : %{http_code}"

出力結果

{"message": "OK"} : 200
に最終更新