ダッシュボードを取得する
最終更新日: 28 年 2021 月 XNUMX 日概要
LogicMonitorのRESTAPIを使用して、アカウントのダッシュボードに関する情報をプログラムで取得できます。 具体的には、ダッシュボードのリストまたは特定のダッシュボードに関する情報を取得できます。
すべてのAPI呼び出しと同様に、 認証が必要です.
ダッシュボードのリストを取得する
HTTPメソッド: GET
リソースURI: /ダッシュボード/ダッシュボード
リクエストパラメータ: デフォルトでは、50個のダッシュボードのリストが返されます。 リクエストに並べ替え、フィルター、フィールド、サイズ、オフセットのパラメーターを含めて、応答に含まれるデータとそのフォーマット方法を制御できます。
プロパティ | 構文 | 説明 | URIの例 |
sort | sort = {+または-} property | 昇順(+)または降順(-)のいずれかで指定されたプロパティで応答を並べ替えます | / dashboard / dashboards?sort = -id |
filter | filter = property {operator} value | 指定された演算子と値に従って応答をフィルタリングします。 *を使用して複数の文字に一致させることができることに注意してください。'。'を使用できますオブジェクト内の値(カスタムプロパティなど)をフィルタリングする文字。複数のフィルターはコンマで区切ることができます。 演算子は次のとおりです。
|
/ dashboard / dashboards?filter = description〜QA * |
フィールド | fields = {コンマで区切られたプロパティのリスト} | 応答をフィルタリングして、各オブジェクトの次のフィールドのみを含めます | / dashboard / dashboards?fields = id、description |
サイズ | size = integer | 表示する結果の数。 最大は1000です | / dashboard / dashboards?size = 5 |
オフセット | offset = integer | 表示された結果を相殺する結果の数 | / dashboard / dashboards?offset = 2 |
例
次のNode.jsスクリプトは、アカウントapi.logicmonitor.comのすべてのダッシュボードを要求します。
// Account Info
var accessId = '48v2wRzfK94y53sq5EuF';
var accessKey = 'H_D9i(f5~B^U36^K6i42=^nS~e75gy382ki8{)P+';
var company = 'api'
// Request Details
var httpVerb = "GET";
var epoch = (new Date).getTime();
var resourcePath = "/dashboard/dashboards";
// Construct signature
var requestVars = httpVerb + epoch + resourcePath;
var crypto = require("crypto");
var hex = crypto.createHmac("sha256", accessKey).update(requestVars).digest("hex");
var signature = new Buffer(hex).toString('base64');
// Construct auth header
var auth = "LMv1 " + accessId + ":" + signature + ":" + epoch;
// Configure request options
var request = require('request');
var options =
{
"method" : httpVerb,
"uri" : "https://" + company + ".logicmonitor.com/santaba/rest" + resourcePath,
"headers": {
'ContentType' : 'application/json',
'Authorization': auth
},
"qs": {
'fields': 'id,name',
'filter': 'name~ip'
}
};
// Make request
request(options, function (error, response, body) {
if (!error && response.statusCode == 200) {
// Print out the response body
console.log(body)
}
});
特定のダッシュボードに関する情報を取得する
HTTPメソッド: GET
リソースURI: /ダッシュボード/ダッシュボード/ {id}
例
次のNode.jsスクリプトは、アカウントapi.logicmonitor.comのダッシュボード34を要求します。
// Account Info
var accessId = '48v2wRzfK94y53sq5EuF';
var accessKey = 'H_D9i(f5~B^U36^K6i42=^nS~e75gy382ki8{)P+';
var company = 'api'
// Request Details
var httpVerb = "GET";
var epoch = (new Date).getTime();
var resourcePath = "/dashboard/dashboards/34";
// Construct signature
var requestVars = httpVerb + epoch + resourcePath;
var crypto = require("crypto");
var hex = crypto.createHmac("sha256", accessKey).update(requestVars).digest("hex");
var signature = new Buffer(hex).toString('base64');
// Construct auth header
var auth = "LMv1 " + accessId + ":" + signature + ":" + epoch;
// Configure request options
var request = require('request');
var options =
{
"method" : httpVerb,
"uri" : "https://" + company + ".logicmonitor.com/santaba/rest" + resourcePath,
"headers": {
'ContentType' : 'application/json',
'Authorization': auth
},
"qs": {
'fields': 'id,name',
'filter': 'name~ip'
}
};
// Make request
request(options, function (error, response, body) {
if (!error && response.statusCode == 200) {
// Print out the response body
console.log(body)
}
});