LogicMonitorのRESTAPIを使用して、Webサイトのすべてのプロパティを取得できます。 Webサイトに直接設定されたプロパティは、で返されるservicePropertiesから直接取得できます。 サービスリソース、ただし、継承されたプロパティ(グループレベルで設定されたプロパティ)を取得するには、特定のWebサイトのプロパティサブリソースをクエリする必要があります。
注:すべてのAPI呼び出しと同様に、 認証が必要です.
HTTPメソッド:GET
リソースURI:/ service / services / {ID} / properties
ここで、IDは、プロパティを取得するWebサイトのIDです。 このIDはから取得できます サービスリソース.
リソースのプロパティ:
リクエストパラメータ: デフォルトでは、50のWebサイトプロパティのリストが返されます。 リクエストに並べ替え、フィルター、フィールド、サイズ、オフセットのパラメーターを含めて、応答に含まれるデータとそのフォーマット方法を制御できます。 クエリパラメータはリソースパスの一部とは見なされないため、LMv1認証署名の計算に含めるべきではないことに注意してください。
プロパティ
|
構文
|
説明
|
URIの例
|
sort |
sort = {+または-} property |
昇順(+)または降順(-)のいずれかで指定されたプロパティで応答を並べ替えます |
/ service / services / 12 / properties?sort = -type |
filter
|
filter = property {operator} value |
指定された演算子と値に従って応答をフィルタリングします。 *を使用して複数の文字に一致させることができることに注意してください。 '。'を使用できますオブジェクト内の値(カスタムプロパティなど)をフィルタリングする文字。複数のフィルターはコンマで区切ることができます。
演算子は次のとおりです。
- 以上: >:
- 以下: <:
- 大なり記号: >
- 未満: <
- 等しくない: !:
- 等しい: :
- 以下の構成です: ~
- 含まれていません: !~
|
/ service / services / 45 / properties?filter = name〜QA *、value〜staging |
フィールド |
fields = {コンマで区切られたプロパティのリスト} |
応答をフィルタリングして、各オブジェクトの次のフィールドのみを含めます |
/ service / services / 89 / properties?fields = name、id |
サイズ |
size = integer |
表示する結果の数。 最大は1000です。 |
/ service / services / 65 / properties?size = 5 |
オフセット |
offset = integer |
表示された結果を相殺する結果の数 |
/ service / services / 76 / properties?offset = 2 |