SiteMonitor(SM)チェックポイントリソースを使用すると、SiteMonitorチェックポイントに関する情報をプログラムで取得できます。
LogicMonitorのRESTAPIを使用すると、次のことができます。
- SiteMonitorチェックポイントのリストを取得する
- 特定のSiteMonitorチェックポイントに関する情報を取得する
注:すべてのAPI呼び出しと同様に、 認証が必要です.
リソースURI
/ service / smcheckpoints
リソースのプロパティ
すべてのSiteMonitorチェックポイントには次のプロパティがあります。
プロパティ
|
詳細説明
|
タイプ
|
| id |
SiteMonitorチェックポイントのID |
整数 |
| 名 |
SiteMonitorチェックポイントの名前 |
String |
| 地理情報 |
SiteMonitorチェックポイントの地理情報(場所) |
String |
| 説明 |
SiteMonitorチェックポイントの説明 |
String |
| 表示優先 |
LogicMonitorポータルでのSiteMonitorチェックポイントの表示優先度 |
整数 |
チェックポイントのリストを取得する
SiteMonitorチェックポイントのリストを返します
HTTPメソッド:GET
URI:/ service / smcheckpoints
リクエストパラメータ:デフォルトでは、すべてのSMチェックポイントが返されます。 応答に含まれるデータとそのフォーマット方法を制御する並べ替え、フィルター、フィールド、サイズ、およびオフセットのパラメーターを含めることができます。 クエリパラメータはリソースパスの一部とは見なされないため、LMv1認証署名の計算に含めるべきではないことに注意してください。
プロパティ
|
構文
|
詳細説明
|
URIの例
|
| sort |
sort = {+または-} property |
昇順(+)または降順(-)のいずれかで指定されたプロパティで応答を並べ替えます |
/ service / smcheckpoints?sort = -id |
| filter
|
filter = property:value |
指定されたプロパティに指定された値を持つ結果のみを含むように応答をフィルタリングします |
/ service / smcheckpoints?filter = name:QAservice |
| フィールド |
fields =コンマで区切られたプロパティのリスト |
応答をフィルタリングして、各オブジェクトの次のフィールドのみを含めます |
/ service / smcheckpoints?fields = name、id |
| サイズ |
size = integer |
表示する結果の数 |
/ service / smcheckpoints?size = 5 |
| オフセット |
offset = integer |
表示された結果を相殺する結果の数 |
/ service / smcheckpoints?offset = 2 |
例1:すべてのSMチェックポイントのリストを取得する
次のリクエストは、すべてのSiteMonitorチェックポイントのリストを返します。
Request:
curl -v --user'apiUser:example '-X GET "https://api.logicmonitor.com/santaba/rest/service/smcheckpoints"
Response:
{"status":200、 "errmsg": "OK"、 "data":{"total":4、 "items":[{"id":1、 "name": "US --Washington DC"、 " geoInfo ":"米国-ワシントンDC "、"説明 ":"これはDC7グループです "、" displayPrio ":50}、{" id ":2、"名前 ":"米国-サンフランシスコ "、" geoInfo ": "US --San Francisco"、 "description": "US --San Francisco"、 "displayPrio":40}、{"id":3、 "name": "Europe-Dublin"、 "geoInfo": "Europe-Dublin "、" description ":" Europe-Dublin "、" displayPrio ":20}、{" id ":4、" name ":" Asia-Singapore "、" geoInfo ":" Asia-Singapore "、" description ": "アジア-シンガポール"、 "displayPrio":10}]、 "searchId":null}
次のリクエストは、ID5のSiteMonitorチェックポイントに関する情報を返します。
Request:
curl -v --user'apiUser:example '-X GET "https://api.logicmonitor.com/santaba/rest/service/smcheckpoints/5"
Response:
{"status":200、 "errmsg": "OK"、 "data":{"id":5、 "name": "Asia-Singapore"、 "geoInfo": "Asia-Singapore"、 "description": 「アジア-シンガポール」、「displayPrio」:10}