ストレージに関連する情報の取得 (v2)
9.2.12 から使用可能です。api/sam/v2/detailed_hw_storages
エレメントに対して GET
操作を使用して、スキャンされたシステム上のストレージ・デバイスに関連する情報を要求します。
権限
この API を使用するには、「エンドポイントの表示」権限および「ハードウェア・インベントリーの表示」権限が必要です。
リソース URL
https://hostname:port/api/sam/v2/detailed_hw_storages?token=token
リソース情報
操作の詳細 | 「説明」 |
---|---|
HTTP メソッド | GET |
要求ヘッダー |
応答の言語をネゴシエーションします。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。 |
要求フォーマット | application/json |
応答ヘッダー |
応答のコンテンツ・タイプを指定します。 |
応答のコンテンツの言語を指定します。ヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。 |
|
応答ペイロード | Storage Device element |
応答フォーマット | application/json |
応答コード |
|
スキーマの説明
GET api/sam/v2/schemas/detailed_hw_storage.json?token=token
選択可能な列
仮想マシンの仕様により、詳細なハードウェア・スキャンで AIX WPAR のストレージに関する情報を取得することができません。
非管理ユーザー・アカウントに割当て量を設定する場合、空きディスク・スペースはディスク・ボリュームで使用可能なスペースより大きくなる場合があります。そのため、ストレージ情報が正確でない可能性があります。Microsoft のポリシーに従って、他のユーザーに割り振られているストレージの割当て量に関する情報を取得するには、管理者である必要があります。
スキャン出力には、このグループの各属性の複数のインスタンスが含まれる可能性があります。
プロパティー | 説明\n | タイプ |
---|---|---|
ID | レコードの ID。 | Integer |
computer_id | BigFix Inventory データベースで指定されているコンピューターの ID | Integer |
updated_at | 現在の情報が BigFix Inventory にインポートされた日時。 | ストリング |
type | ストレージ・デバイスのタイプ。 | ストリング |
モデル | ストレージ・デバイスのモデル。 | ストリング |
製造メーカー | ストレージ・デバイスの製造メーカー。 | ストリング |
total_size | ハード・ディスクのサイズ (メガバイト (MB) 単位) | ストリング |
デバイス (device) | ストレージ・デバイスの固有のシステム ID。この情報はオプションです。 | ストリング |
関連 API
照会パラメーター
パラメーター | 「説明」 | 必須 | 値 |
---|---|---|---|
columns[] | 取得する列を指定します。このパラメーターを指定しなかった場合、デフォルトの列のみが取得されます。 例: コンピューター ID の取得:
|
ストリング | |
order | 返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に desc を追加します。 例: コンピューター ID の降順での並び替え:
注: デフォルトでは、この API の limit パラメーターは 100000 に設定されています。 |
ストリング | |
限界値 | 取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。 例: 100 件のレコードの取得
|
数字 | |
offset | 結果の取得でスキップする行数を指定します。これを limit パラメーターと一緒に使用して、結果をページ編集できます。 例: レコード 150 の後から始まる 50 件のレコードの取得
|
数字 | |
token | 固有のユーザー認証 ID。認証トークンを取得するための REST API を使用して取得することができます。BigFix Inventory にログインして「ユーザー」アイコンにカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。 | ✓ | 英数字 |
criteria | 特定の条件と合致するレコードを取得します。このパラメーターでは、以下の構造が 1 行で記述されている必要があります。
演算子について詳しくは、以下を参照してください。「共通のコネクターおよび演算子」。 例: コンピューター ID が1000より大きいコンピューターの取得。
日時の値を使用する列の場合、特定の日付の代わりにある期間のデータを取得することもできます。これを行うには、last または next を <operator> として使用し、次の規則で時刻の値を指定します。PxD/PxW/PxM/PxY。ここで、x は 1 から 999 の範囲の数値であり、D、W、M、Y はそれぞれ、日、週、月、年を表す指定子です。 |
ストリング |
会話例 - デフォルトの列
- 要求
-
GET api/sam/v2/detailed_hw_storages?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 Host: localhost:9081 Accept: application/json Accept-Language: en-US
- 応答本文
-
[{ "id":1, "computer_id":1, "updated_at":"2018-05-28T01:22:16Z", "type":"Hard Disk", "model":"Virtual disk", "manufacturer":"VMware", "total_size":"40960", "device" "/dev/sda" }]
会話例 - 選択された列
- 要求
-
GET api/sam/v2/detailed_hw_storages?columns[]=computer_id &columns[]=model&columns[]=manufacturer &token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 Host: localhost:9081 Accept: application/json Accept-Language: en-US
- 応答本文
-
[{ "computer_id":1, "model":"Virtual disk", "manufacturer":"VMware" }]