サポートセンターホーム


サービス(Webサイト)APIリソースについて

サービスリソースを使用すると、LogicMonitorWebサイトをプログラムで管理できます。

リソースURI:

/ service / services

リソースのプロパティ:

すべてのWebサイトには、次のプロパティがあります。

プロパティ

製品説明

種類

type ping | ウェブサービス
ウェブサイトの種類
文字列 「タイプ」:「ウェブサービス」
id ウェブサイトのID 整数 「id」:21
ウェブサイトの名前 文字列 「名前」:「CName_check」
説明 ウェブサイトの説明 文字列 「説明」:「メインページチェック(cname)」
serviceFolderId Webサイトが存在するフォルダーのID 整数 「serviceFolderId」:12
停止監視 true:Webサイトの監視が無効になっています
false:Webサイトの監視が有効になっています
If 停止監視= trueの場合、アラートはデフォルトでWebサイトに対して無効になります
ブーリアン 「stopMonitoring」:false
stopMonitoringbyFolder true:Webサイトのフォルダー内のすべてのサービスの監視が無効になっています
false:Webサイトのすべてのサービスで監視が無効になっているわけではありませんのフォルダ
ブーリアン 「stopMonitoringByFolder」:false
無効にするアラート true:Webサイトのアラートが無効になっています
false:アラートが有効になっている ウェブサイト
If 停止監視= trueの場合、アラートはデフォルトで無効になります ウェブサイト
ブーリアン 「disableAlerting」:false
個別のSmAlertEnable true:個々のテスト場所からのチェックが失敗した場合にアラートがトリガーされます
false:個々のテスト場所からのチェックが失敗した場合、アラートはトリガーされません
ブーリアン 「individualSmAlertEnable」:true
個人アラートレベル 警告| エラー| クリティカル
Webサイトが個々のテスト場所からのチェックに失敗した場合にトリガーするアラートのレベル
文字列 「individualAlertLevel」:「エラー」
全体的なアラートレベル 警告| エラー| クリティカル
Webサイトが指定されたチェック数に失敗した場合にトリガーするアラートのレベル 遷移 によって指定されたテスト場所から globalSmAlertCond
文字列 「overallAlertLevel」:「クリティカル」
アラートステータス Webサイトのアラートが現在あるかどうか、およびアラートが確認されたかどうかを示すステータス。 このステータスプロパティには、次の形式のXNUMXつの値があります。
{acknowledged} – {alertLevel}、ここで
承認済み:確認済み| 未確認
alertLevel:警告| エラー| クリティカル
文字列 「alertStatus」:「none」
alertStatusPriority アラートをツリーに表示する方法を決定するためにUIが使用する値 整数 「alertStatusPriority」:100000
sdtステータス WebサイトにSDTが設定されているかどうかを示すステータス。 このステータスプロパティには、次の形式のXNUMXつの値があります。
「{serviceGroupSDT} – {serviceSDT} –なし」。ここで、serviceGroupSDTとserviceSDTは「SDT」または「none」のいずれかになります。
文字列 「sdt​​Status」:「none-none-none」
alertDisableStatus Webサイトのアラートが無効になっているかどうかを示すステータス。 このステータスプロパティには、次の形式のXNUMXつの値があります。
「{serviceGroupAlertingDisabled} – {serviceAlertingDisabled} –なし」。ここで、serviceGroupAlertDisabledとserviceAlertDisabledは「無効」または「なし」のいずれかになります。
文字列 「alertDisableStatus」:「none-none-none」
ポーリング間隔 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
Webサイトのポーリング間隔(分単位)。 この値は、Webサイトがチェックされる頻度を示します。 最小は1分、最大は10分です。
整数 「pollingInterval」:1
遷移 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 30 | 60
アラートがトリガーされる前に失敗しなければならないチェックの数
整数 「移行」:1
testLocation Webサイトが監視されている場所。 Webサイトが内部の場合、このフィールドにはコレクターを含める必要があります。 非内部の場合、可能なテスト場所は次のとおりです。
1:米国– LA
2:米国– DC
3:米国– SF
4:ヨーロッパ–ダブリン
5:アジア–シンガポール
6:オーストラリア–シドニー
testLocation:” {all:true}”は、サービスがすべてのチェックポイントの場所から監視されることを示します
testLocation:” {smgIds:[1,2,3]}”は、サービスがチェックポイントの場所1、2、および3から監視されることを示します。
testLocation:” {collectorIds:[85,90]}”は、サービスがコレクター85および90によって監視されることを示します
JSONオブジェクト “ testLocation”:“ {“ all”:true}”
globalSmAlertCond アラートをトリガーするためにチェックが失敗する必要があるテスト場所の数。トリガーされるアラートは、の値と一致します。 全体的なアラートレベル。 可能な値と対応するサイトモニターの場所の数は次のとおりです。
0:すべて
1:半分
2:複数
3:任意
整数 「globalSmAlertCond」:0
useDefaultLocationSetting true:Webサイトのデフォルト設定で構成されたチェックポイントの場所が使用されます
false:で指定されたチェックポイントの場所 testLocation 使用されます
ブーリアン 「useDefaultLocationSetting」:false
useDefaultAlertSetting true:Webサイトのデフォルト設定で構成されたアラート設定が使用されます
false:サービスのデフォルト設定は使用されないため、individualSMAlertEnable、individualAlertLevel、globalSmAlertConf、overallAlertLevel、およびpollingIntervalを指定する必要があります。
ブーリアン 「useDefaultAlertSetting」:false
userPermission 書く| 読む| ack
APIリクエストを行ったユーザーの権限レベル
文字列 「userPermission」:「write」
チェックポイント Webサイトが監視されているチェックポイント。 このオブジェクトは、で指定された各場所を参照する必要があります testLocation 「全体」チェックポイントに加えて。 JSONオブジェクト 「チェックポイント」:[{「id」:98、「geoInfo」:「全体」、「smgId」:0}、{「id」:102、「geoInfo」:「アジア-シンガポール」、「smgId」:5} 、{“ id”:101、” geoInfo”:“ Europe – Dublin”、” smgId”:4}、{“ id”:99、” geoInfo”:“ US – San Francisco”、” smgId”:3}、 {“ id”:97、” geoInfo”:“ US – Washington DC”、” smgId”:2}]
serviceProperties Webサイトに関連付けられているプロパティ JSONオブジェクト 「serviceProperties」:[{「name」:「billing」、「value」:「website」}、{「name」:「team」、「value」:「TechOps」}、{「name」:「production」、 ” value”:“ true”}]
isInternal ウェブサイトが内部にあるかどうか ブーリアン 「isInternal」:true
コレクター ウェブサイトが内部にある場合、ウェブサイトを監視しているコレクター JSONオブジェクト “collectors”:[{“id”:85,”description”:”ip-172-31-37-162.us-west-2.compute.internal”,”hostname”:”ip-172-31-37-162.us-west-2.compute.internal”,”collectorGroupId”:1,”collectorGroupName”:”@default”}]

追加のpingサービスプロパティ

タイプ「ping」のWebサイトチェックには、すべてのサービスについて上記のプロパティに加えて、次のプロパティがあります。

プロパティ

製品説明

種類

カウント 送信するパケットの数 整数 「カウント」:20
host スキームやプロトコルなしでチェックするURL(例:httpまたはhttps)
たとえば、URLが「https://www.google.com」の場合、host =” www.google.com”
文字列 「ホスト」:「kittens.test.logicmonitor.com」
パーセントPktsNotReceiveInTime で指定された期間内に返される必要があるパケットの割合 timeoutInMSPktsNotReceive pingチェックごとに。 整数 「percentPktsNotReceiveInTime」:70
timeoutInMSPktsNotReceive で指定されたパケットの割合が指定された期間 パーセントPktsNotReceiveInTime pingチェックごとに返送する必要があります。 整数 「timeoutInMSPktsNotReceive」:300

追加のWebサービスプロパティ

タイプ「webservice」のWebサイトチェックには、すべてのサービスについて上記のプロパティに加えて、次のプロパティがあります。

プロパティ

製品説明

種類

ステップ XNUMXつ以上のステップで構成されるオブジェクト。各ステップに含まれるプロパティについては、以下の表を参照してください。 JSONオブジェクト 「steps」:[{「HTTPHeaders」:「」、「statusCode」:「」、「followRedirection」:true、「matchType」:「plain」、「keyword」:「」、「HTTPBody」:「」、「HTTPMethod ”:“ GET”、” postDataEditType”:“ raw”、” label”:“”、” url”:“ target.com”、” fullpageLoad”:false、” requireAuth”:false、” auth”:null、” invertMatch”:false、” timeout”:30、” HTTPVersion”:“ 1.1”、” schema”:“ http”、” description”:“”、” path”:“”、” enable”:true、” name” :“ __ step0”、” domain”:“ target.com”}]
SSLを無視 本当| 偽
SSLを無視するかどうか
ブーリアン 「ignoreSSL」:false
pageLoadAlertTimeInMS アラートのトリガーを回避するために、各ステップでページをロードする必要があるミリ秒単位の時間。 整数 「pageLoadAlertTimeInMS」:30000
スクリプト 非推奨(将来的に再導入される予定)
方法 非推奨(将来的に再導入される予定)

JSONオブジェクトの「ステップ」はXNUMXつ以上のステップで構成され、各ステップには次のプロパティがあります。

プロパティ

製品説明

種類

HTTPヘッダー HTTPリクエストに含まれるヘッダー 文字列 「HTTPHeaders」:「Content-Type:application / x-www-form-urlencoded」
ステータスコード HTTPリクエストの予想される応答ステータスコード。 複数のステータスコードはカンマで区切ることができます 文字列 「statusCode」:「200」
ラベル 非推奨の
followリダイレクト true:HTTPリクエストは、適切なリダイレクトに従います
false:HTTPリクエストはリダイレクトに従いません
ブーリアン 「followRedirection」:true
マッチタイプ プレーン| レギュラー| ワイルドカード
応答でキーワードを検索するために使用される解釈方法のタイプ。
プレーン:プレーンテキスト
正規表現:正規表現
ワイルドカード:グロブ式
文字列 「matchType」:「plain」
キーワード HTTPリクエストへの応答で検索される文字列キーワード 文字列 「キーワード」:「LogicMonitor」
HTTPBody HTTPリクエストの本文のデータ 文字列 「HTTPBody」:「login_pwd = example&login_userid = sarah」
HTTPメソッド GET | HEAD | 役職
HTTPリクエストメソッド 
文字列 「HTTPMethod」:「POST」
postDataEditType 生| json | xml | x-www-form-urlencoded
POSTデータの形式
文字列 「postDataEditType」:「x-www-form-urlencoded」
URL ステップをチェックするためのURL(ドメインを含む) 文字列 「url」:「logicmonitor.docebosaas.com / lms /」
fullpageLoad true:HTTPリクエストは、すべてのページ要素が読み込まれるのを待ちます
false:HTTPリクエストは、すべてのページ要素が読み込まれるのを待ちません
ブーリアン 「fullpageLoad」:false
requireAuth true:HTTPリクエストには承認が必要です 
false:HTTPリクエストには承認は必要ありません 
ブーリアン 「requireAuth」:false
認証 requireAuth = trueの場合に必要な認証情報。 このJSONオブジェクトには次のものが含まれます。
タイプ:共通| ベーシック| ntlm
userName
パスワード
ドメイン(type = ntlmの場合のみ)
JSONオブジェクト “ auth”:{“ type”:” common”、” userName”:” test”、” password”:” example”}
invertMatch true:キーワードは応答に存在してはなりません
false:キーワードは応答に存在する必要があります
ブーリアン 「invertMatch」:false
タイムアウト 1 5 15 30 60 120 180
HTTPリクエストがタイムアウトするまでにページをロードする必要がある秒数
整数 「タイムアウト」:30
HTTPVersion 1.0 | 1.1
Webサービスのチェックに使用されるHTTPバージョン
文字列 「HTTPVersion」:「1.1」
スキーマ http | https
チェックするURLに関連付けられたスキームまたはプロトコル
文字列 「スキーマ」:「http」
説明 ステップに関連する説明 文字列 「説明」:「ログイン資格情報の投稿」
path ステップに関連付けられたパス。パスはドメインの後のURLコンポーネントです。 文字列 「パス」:「/ main.html」
enable true | false。 ステップが有効かどうか ブーリアン 「有効にする」:true
ステップの番号順。 例:_step2 文字列 「名前」:「__ step0」
ドメイン サービスのドメイン。 これはサービスのベースURLです。 文字列 「ドメイン」:「kittens.test.logicmonitor.com」

記事上で