クラスターの取得

ホスト・コンピューター・システムをグループ化するクラスターに関する情報を要求するには、api/sam/clusters エレメントに対して GET 操作を使用します。この情報は、ご使用の環境の現在の状態を表し、履歴データは含まれていません。

クラスターの ID を取得した後、それらの ID を、コンピューター・システムの API によって取得される cluster_id 列と比較して、これらのシステムのどれがどのクラスターに属しているかを認識します。この情報は、ユーザー・インターフェースで「ハードウェア・インベントリー」レポートにも表示できます。

クラスターに関する情報を取得するには、次の URL を使用します。 
https://hostname:port/api/sam/clusters?token=token
重要:
  • この API を使用するには、「すべてのコンピューター」グループに割り当てられていて、「ハードウェア・インベントリーの表示」権限が付与されている必要があります。
  • 各 API 要求は、token パラメーターを使用して認証する必要があります。認証トークンを取得するための REST API を使用して取得することができます。BigFix Inventory にログインして「ユーザー」アイコン「ユーザー」アイコンにカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。
  • デフォルトでは、取得したデータは id 別にソートされます。
表 1. 操作の説明
操作の詳細 「説明」
操作 GET /api/sam/clusters
目的 クラスターのリストを返します。
HTTP メソッド GET
リソース URI https://server_host_name:port_number/api/sam/clusters
URL リンク関係 n/a
URI 照会パラメーター 適用可能な照会パラメーターのリストについては、以下を参照してください。「照会パラメーター」。
要求ヘッダー
ヘッダー
Accept-Language (オプション)
値
en-US (英語のみをサポート)

応答の言語のネゴシエーションに使用されます。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
要求ペイロード n/a
要求 Content-Type
  • application/json
応答ヘッダー
ヘッダー
Content-Type
値
application/json

応答のコンテンツ・タイプを指定します。
ヘッダー
Content-Language
値
en-US, …

応答のコンテンツの言語を指定します。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。
ヘッダー
Import-Mode
値
none､idle､running､pending

データ・インポートの状況を示します。
ヘッダー
Import-Progress
値
パーセント値 (例: 59)。

データ・インポートの進行状況をパーセントで示します。
ヘッダー
Import-Last-Status
値
successful、 failed

最後のデータ・インポート状況を示します。
ヘッダー
Import-Last-Success-Time
値
日付 (例: 2014-06-18T04:00:29Z)。

最後の正常なデータ・インポートの時刻を示します。
応答ペイロード Clusters element
応答 Content-Type
  • application/json
正常な HTTP 応答コード
  • 200 – OK
エラーの HTTP 応答コード
  • 500 – "Bad Request" 照会パラメーターにエラーがあるか、照会パラメーターが欠落している場合

メッセージの本文にはエラー・メッセージと詳細が含まれます。

照会パラメーター

照会パラメーターは、検索結果の絞り込みに使用できます。以下の表は、api/sam/clusters エレメントに対して使用できる照会パラメーターを示しています。
表 2. クラスターを取得するための照会パラメーター
パラメーター 「説明」 必須 値
columns 取得する列を指定します。このパラメーターを指定しない場合は、一連のデフォルトの列が取得されます。使用可能な列については、応答の本文を参照してください。例:
名前と id の列を取得します。
URL?columns[]=name&columns[]=id
 いいえ ストリング
order 返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に desc を追加します。例:
タイプの降順で並び替えるには、次のように指定します。
URL?order[]=type desc
 いいえ ストリング
限界値 取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。 いいえ 数字
offset 結果の取得でスキップする行数を指定します。これを limit パラメーターと一緒に使用して、結果をページ編集できます。例:
レコード 150 の後から始まる 50 件のレコードを取得するには、次のとおり指定します。
URL?limit=50&offset=150
 いいえ 数字
token 固有のユーザー認証 ID。自分のトークンは、BigFix Inventory の「プロファイル」設定に表示できます。 はい 英数字

HTTP 会話の例

要求
GET api/sam/clusters
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
応答ヘッダー
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
上記の応答ヘッダーの後には、Import-Mode で表わされるデータ・インポートの現在の状況に応じてそれぞれ異なる項目が続きます。返される値について理解するために、以下の定義を確認してください。
  • none - データ・インポートが一度も開始されていない
  • idle - データ・インポートは現在実行されていない
  • running - データ・インポートは進行中
  • pending - ユーザー・インターフェースで実行されるアクションが、データ・インポートを開始して変更を有効にすることを必要とする
データ・インポートが一度も開始されていない場合:
Import-Mode: none
データ・インポートが進行中の場合:
Import-Mode: running
Import-Progress: 41
データ・インポートが実行されていない場合:
Import-Mode: idle/pending
Import-Last-Status: successful
Import-Last-Success-Time: Mon, 23 Jun 2014 12:18:29 GMT
応答の本文 (JSON)
{	
 "id": 1,
 "name": "Production Cluster 1",
 "cores_count": 24,
 "vm_manager_url": "https://198.51.100/sdk",
}
結果に vm_manager_status 列を追加する例
API: /api/sam/clusters?columns[]=name&columns[]=cores_count&columns[]=vm_manager_url&columns[]=vm_manager_status
応答:
{
 {
   { 
     "id": 1,
     "name":
     "Production Cluster 1",
     "cores_count": 24, 
     "vm_manager_url":
     "https://198.51.100/sdk",
     "vm_manager_status": "98"
   }
 }
}
非アクティブな VM マネージャーからデータを除外する例
API: api/sam/clusters?criteria=\
{
 "and":
  [
    [
      "vm_manager_status","!=","98"
    ]
   ]
}

その他の VM マネージャーの状況について詳しくは、VM マネージャーの取得を参照してください。