REST API 変更ログ

最終更新日: 10 年 2023 月 XNUMX 日

この記事では、各バージョンでの LogicMonitor REST API の変更点を強調しています。 これにより、API がどのように進化し、改善されたかを明確に把握できます。

一般的な変更

REST API v1 および v2 のサポート終了のお知らせ

LogicMonitor REST API v1 および v2 を廃止することを決定しました。 3 年 2023 月から API v1 に移行することをお勧めします。API v2 と v2024 は 3 年 XNUMX 月まで引き続きサポートされ、その後はサポートが停止されます。 API vXNUMX への移行を支援するために、サポート終了日を事前にお知らせします。 詳細については、を参照してください。 LogicMonitor REST API v1 および v2 の廃止.

REST API フィルター

エンドポイントGETを呼び出すと /alert/alerts フィルターを使用すると、以前は、新しいアラートがなくても、結果が一貫せず、シャッフルされていました。 この問題は修正されました。 新しいアラートが生成されたり、既存のアラートがクリアされたりしない限り、結果はシャッフルされず、アラート リストの順序は一貫したままです。 詳細については、を参照してください。 REST API 基本フィルター および REST API 高度なフィルター.

LMv1 トークン

アプリケーションは、API と SDK を使用して複数のバックエンド プラットフォームに接続し、バックエンド プラットフォームで API と SDK を認証するためのトークン/シークレットを提供します。 認証するために、ユーザーは多くの場合、セキュリティ上の重大な問題につながるソース コードと一緒にシークレット/トークンを入力します。 セキュリティ対策として、トークンのフォーマットを改訂しました。 

LMv1 トークンは、access_id+access_key+payload+time+http_method を使用して動的に構築されます。 10 分間しか有効ではないため、リポジトリに保存したりコミットしたりしても意味がありません。

  • access_id – サイズ 20 の英数字で構成されます。たとえば、 32WDPj2KIdZikg7g98SR
  • access_key – サイズ 120 の英数字で構成されます。たとえば、 lma_A4S8)Ps9^jT9[4YFN4S36yG~+uF[h4tG){]]827McL=E3RtaqED%+{(n2p%+LOTRhYjc3ZmQtNmI2MC00M2EzLWJlZjYtMGQ3MmVhOTEwYzA3L0BeLhN  

REST APIv3での変更

numOfKuberntesDevices フィールドの追加

追加しました Kuberntes デバイスの数 フィールドを DeviceGroup API モデル。 を参照するすべてのエンドポイントの応答本文に存在します。 DeviceGroup API モデル。 ターゲット グループ内の Kubernetes リソースの数を示します。 また、ターゲット グループのサブ グループ内の Kubernetes リソースの数も含まれます。

例: 

HTTPメソッドAPIレスポンス
GET
PUT
PATCH
サンタバ/休息/デバイス/グループ/{id}
POST
GET
サンタバ/休息/デバイス/グループ

選択した場合:

  • ルート グループ (id = 1) – 応答本文には、ポータルに存在するすべての Kubernetes デバイスの数が含まれます。
  • 特定のデバイス グループ – 応答本文には、そのデバイス グループに存在する Kubernetes デバイスの数が含まれます。

新しいエンドポイント

REST API v3 の主なハイライトは、XNUMX つの新しいエンドポイントの追加です。 彼らです:

  • POST – /setting/datasources/{id}/audit
  • POST – /setting/evensources/{id}/audit
  • POST – /setting/configsources/{id}/audit
  • POST – /setting/propertyrules/{id}/audit
  • GET – /setting/integrations/auditlogs

詳細については、を参照してください。 REST API v3 Swagger ドキュメント.

REST APIv2での変更

LogicMonitor REST API v2 には、非下位互換性などの新機能が含まれています。

ステータスコード

REST API v1 では、応答に 200 つの状態コードがありました。HTTP 状態コード (ほとんど常に 2) と、応答本文の別の LogicMonitor 状態コードです。 REST API vXNUMX では、HTTP ステータス コードを XNUMX つ返すようになり、返される可能性のあるステータス コードのリストを大幅に絞り込みました。 

基本認証のサポートなし

REST API v2 での基本認証のサポートを削除しました。 多くの追加の利点 (UI/API アクセスの分離、監査ログ エントリ、およびより安全) があるため、認証のための API トークンのより多くの使用を促進するためにこれを行いました。

PATCH メソッドのサポート

REST API v2 には、ほとんどのリソースに対する HTTP PATCH のサポートが含まれています。 これは、PUT を使用してリソース全体 (すべてのフィールド) を更新するのではなく、リソースの XNUMX つのフィールドのみを更新する場合に便利です。 

レスポンスボディ構造

REST API v1 では、成功した応答が含まれていました status, エラーメッセージデータ 応答のトップ レベルのオブジェクト。 REST API v2 では、HTTP ステータスが LM ステータスと一致するようになったため、成功応答の最上位で「data」の内容が返されます。 失敗した応答には、エラー メッセージ フィールドが含まれます。 これは、REST API v1 用に作成され、API 応答を解析するように構成されたスクリプトを、これを反映するように調整する必要があることを意味することに注意してください。

記事上で