LogicMonitor REST API v2 から API v3 への移行
最終更新日 - 25年2025月XNUMX日
LogicMonitor REST API v3には、API v2と比較してすべての機能強化と修正が含まれています。API v3への移行が必要な主な理由は次のとおりです。
- API v3 バージョン ヘッダーの更新
- フィルタ構文のサポート
LogicMonitor REST API v2 から v3 への変更
REST API v2 から API v3 へのバージョン ヘッダー
次のいずれかのバージョン ヘッダーを使用して、API v3 リクエストを行うことができます。
- ヘッダーXバージョン、値3。例：「Xバージョン: 3」
- APIクエリパラメータ
v値は3です。例えば、「v=3」
詳細については、を参照してください。 REST API v3 Swagger ドキュメント.
REST API v2 および API v3 の API レスポンス形式
API v2とAPI v3の成功およびエラーレスポンスの形式に違いはありません。そのため、API v2からAPI v3に移行しても、解析ロジックに変更を加える必要はありません。
REST API v2 および v3 の成功応答
API v3 の成功応答形式は次のとおりです。
{
<API specific data>
}REST API v2 および API v3 のエラー応答
API v3 のエラー応答形式は次のとおりです。
{
"errorMessage": <ERROR_MESSAGE>,
"errorCode": <ERROR_CODE>,
"errorDetail": null
}Pythonコードでのレスポンス形式の例
import json
# Success Response Handling
def handle_success_response(json_response):
response = json.loads(json_response)
# Process the fields directly from the response
# Example: total = response['total']
# Error Response Handling
def handle_error_response(json_response):
response = json.loads(json_response)
error_message = response['errorMessage']
error_code = response['errorCode']
error_detail = response['errorDetail']
# Process the error message, code, and detail