アラート取得
最終更新日: 17 年 2023 月 XNUMX 日概要
LogicMonitorのRESTAPIを使用すると、アカウントのアラートをプログラムで取得できます。 すべてのAPI呼び出しと同様に、 認証が必要です.
注: 特定のアラートをリクエストしようとしている場合 デバイス, デバイスグループまたは サービス、これらのリソースのアラートサブリソースの使用を検討してください。
詳細依頼フォーム
アラートのリストを返します
HTTPメソッド: GET
URI: / alert / alerts
リクエストパラメータ: デフォルトでは、50個のアラートのリストが返されます。 応答に含まれるデータとそのフォーマット方法を制御する次のクエリパラメーターを含めることができます。 クエリパラメータはリソースパスの一部とは見なされないため、LMv1認証署名の計算に含めるべきではありません。
プロパティ | 構文 | 説明 | URIの例 |
sort | sort = {+または-} property | 昇順(+)または降順(-)のいずれかで指定されたプロパティで応答を並べ替えます | / alert / alerts?sort = -startEpoch |
filter | filter = _all〜value | 指定された値を含む結果のみを含むように応答をフィルタリングします。 _allをフィールド名に置き換えて、特定のフィールドのみをフィルタリングできます。 フィルタリングは、id、type、acked、rule、chain、severity、cleared、sdted、startEpoch、monitorObjectName、monitorObjectGroups、resourceTemplateName、instanceName、およびdataPointNameでのみ使用できることに注意してください。 オペレーターは次のとおりです。
| / alert / alerts?filter = _all〜serviceAlert |
フィールド | fields =コンマで区切られたプロパティのリスト | 応答をフィルタリングして、各オブジェクトの次のフィールドのみを含めます | / alert / alerts?fields = type、id、acked、severity |
サイズ | size = integer | 表示する結果の数。最大1000件の結果をリクエストできます。 | / alert / alerts?size = 10 |
オフセット | offset = integer | 表示された結果を相殺する結果の数 | / alert / alerts?offset = 20 |
必要なメッセージ | needMessage = true | false | 詳細なアラートメッセージを応答に含める必要があるかどうか | / alert / alerts?needMessage = true |
カスタムカラム | customColumns = value1、value2、value3 | アラートの詳細とともに表示されるプロパティまたはトークンの値。 トークンを参照する場合は、#記号をURLエンコードする必要があることに注意してください。 | /alert/alerts?customColumns=%2523%2523system.collectorid%2523%2523,%2523%2523system.groups%2523%2523 |
注: デフォルトでは、アクティブなアラートのみが返されます。 応答でクリアされたアラートとアクティブなアラートを取得するには、「cleared:*」のフィルターを追加します。 LogicMonitor REST API v2 を使用している場合は、「cleared: “*”」のフィルターを追加します。
注: リクエストに含まれていなかったリクエスト基準を満たす追加のアラートがあり、「少なくとも」その数のアラートが存在する場合、応答「合計」は負の数になります。 たとえば、最初の500アラートをリクエストし、アカウントに3000アラートがある場合、応答にはtotal = -1000が含まれる可能性があります(つまり、少なくとも1000アラートがありますが、すべてを要求していません)。
例
次のPythonスクリプトは、アラートのリストと、各アラートの## externalticketid ##の値を要求します。
#!/bin/env python
import requests
import json
import hashlib
import base64
import time
import hmac
#Account Info
AccessId ='48v2wRzfK94y53sq5EuF'
AccessKey ='H_D9i(f5~B^U36^K6i42=^nS~e75gy382Bf6{)P+'
Company = 'api'
#Request Info
#Request Info
httpVerb ='GET'
resourcePath = '/alert/alerts'
data=''
queryParams ='?customColumns=%2523%2523externalticketid%2523%2523'
#Construct URL
url = 'https://'+ Company +'.logicmonitor.com/santaba/rest' + resourcePath + queryParams
#Get current time in milliseconds
epoch = str(int(time.time() * 1000))
#Concatenate Request details
requestVars = httpVerb + epoch + data + resourcePath
# Construct signature
hmac1 = hmac.new(AccessKey.encode(),msg=requestVars.encode(),digestmod=hashlib.sha256).hexdigest()
signature = base64.b64encode(hmac1.encode())
# Construct headers
auth = 'LMv1 ' + AccessId + ':' + signature.decode() + ':' + epoch
headers = {'Content-Type':'application/json','Authorization':auth}
# Make request
response = requests.get(url, data=data, headers=headers)
# Print status and body of response
print('Response Status:',response.status_code)
print('Response Body:',response.content)