(2018/11/27: 訂正) mkr 0.34.0に不備がありましたので修正しました。新API対応版はmkr 0.34.2 をご利用ください。
いつもMackerelをご利用いただきありがとうございます。
Mackerelディレクターの id:daiksy です。
アラート取得APIについて、かねてから強い要望のあったクローズ済みアラートの取得機能を今週追加します。それに伴い、アラート取得APIに非互換な仕様変更を行う必要があるため事前にお知らせさせていただきます。
仕様変更の影響範囲は以下となります。
- 現在、API経由でオープンアラートリストを取得しているユーザー
- 101件以上アラートが開いている場合は同時に取得できなくなります
- mkrを用いてアラートリストを取得している場合は、mkr 0.34.2 以降では内部的にケアされるので、前もってmkrを更新しておけば影響はありません
リリース日と仕様変更の内容については下記となります。
- リリース日: 2018年11月29日 (木)
- リリース内容: アラート取得APIに、クローズ済みアラートを取得するためのパラメータ
withClosed
limit
nextId
を追加します - 非互換な変更内容: limitのデフォルト値が100となるため、変更前と同様のリクエストについては発生中アラートの取得も、取得件数の最大値が100件となります
クローズ済みアラートの件数は累積されるため、長期間運用されたオーガニゼーションについては、件数が膨大な数になる場合があります。そのため、クローズ済みアラート取得に際しては何らかのページング処理を追加する必要がありました。ページング処理の追加によって、従来のAPIの挙動にも影響が及ぶため、今回の仕様変更に対して事前のお知らせをさせていただきます。
mkrとmackerel-client-goについて
mkrについては、mkr 0.34.0 までのバージョンを11月29日以降に使用すると、アラートの取得件数が100件までしか取得できませんのでご注意ください。mkrとmackerel-client-goの新API対応版はすでに提供済みですので、必要に応じて更新をお願いします。
今後ともMackerelをよろしくお願いします。