データ・インポートの実行
9.2.2 から使用可能です。この REST API を使用して、データ・インポートの状況を検査したり、未加工のデータのみまたは完全なデータのインポートを実行したりできます。これらのアクションはすべて、共通の API 要求を通じて実行されます。これらを区別するには、要求に特定のパラメーターを追加します。この API を使用するには、api/import_status.json
エレメント、またはその別名である api/management/imports.json
に対して GET
操作を使用します。
始める前に
You must have the Manage Imports permission to perform this task.
インポート状況の検査
データ・インポートの実行を開始する前に、データ・インポートの状況を取得して、現在進行中のデータ・インポートがないことを確認します。取得可能な状況は、「HTTP 会話の例」で説明されています。インポート状況を検査するには、以下の要求を使用します。
https://hostname:port/api/import_status.json?token=token
「未加工のデータのみ」インポートの実行
「未加工のデータのみ」インポートを実行すると、未加工のスキャン結果のみを取得するため、処理が高速です。このタイプのデータ・インポートは、REST API を使用して未加工のスキャン結果を取得するために使用されます。「未加工のデータのみ」データ・インポートには、インポート処理の以下のステップがあります。
- モデルの初期化:
Calling Model.before_snapshot
- 各データ・ソースの初期化:
Initialize datasource #{datasource.name}
- コンピューター・データ:
RawComputerId Computer ComputerPropertyValue ComputerDimension
- コンピューター関連ファイル:
RawDatasourceFile DatasourceFile SAM::ScanFile
- スキャン済みのファイル、パッケージ、UNIX パッケージ、およびアプリケーション使用状況データ:
SAM::FileFactDelta SAM::FileFact SAM::RawPackageFact SAM::PackageFact SAM::RawUnixPackageFact SAM::UnixPackageFact SAM::RawAppUsagePropertyValue SAM::AppUsagePropertyValue
未加工データのインポートを開始するには、API 要求に run パラメーターを追加し、値として raw_only を指定します。
https://hostname:port/api/import_status.json?token=token&run=raw_only
注: 「未加工のデータのみ」データ・インポートを実行した後、その未加工データを REST API により取得できますが、これは UI には表示されません。UI には、引き続き最後の正常なデータ・インポートによる環境の状態が表示されます。唯一の例外は、「課金データ」レポートに、未加工のみのデータ・インポートの後に最新のデータ・イベントが表示されることです。詳しくは、「未加工スキャン・データのインポート」を参照してください。
完全なデータ・インポートの実行
REST API を使用して完全なインポートを実行することは、UI からデータ・インポートを実行するのと同じ効果があります。データのインポートを開始するには、API 要求に run パラメーターを追加し、値として Complete を指定します。
https://hostname:port/api/import_status.json?token=token&run=complete
操作の説明
注: 各 API 要求は、token パラメーターを使用して認証する必要があります。これは、認証トークンを取得するための REST API を使用して取得できます。BigFix Inventory にログインして「ユーザー」アイコン にカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。
操作の詳細 | 「説明」 |
---|---|
操作 | GET /api/import_status.json 。またはGET /api/management/imports.json |
目的 | データのインポートの状況を返します |
HTTP メソッド | GET |
リソース URI | https://server_host_name:port_number/api/import_status.json。またはhttps://server_host_name:port_number/api/management/imports.json |
URL リンク関係 | n/a |
URI 照会パラメーター | n/a |
要求ヘッダー |
応答の言語のネゴシエーションに使用されます。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。 |
要求ペイロード | n/a |
要求 Content-Type |
|
応答ヘッダー |
応答のコンテンツ・タイプを指定します。 |
応答のコンテンツの言語を指定します。このヘッダーを指定しない場合、コンテンツはサーバーの言語で戻されます。 |
|
応答ペイロード | Import status element |
応答 Content-Type |
|
正常な HTTP 応答コード |
|
エラーの HTTP 応答コード |
メッセージの本文にはエラー・メッセージと詳細が含まれます。 |
照会パラメーター
照会パラメーターを使用して、検索結果を絞り込んだり、追加アクションを実行したりできます。以下の表は、api/import_status.json および api/management/imports.json エレメントに対して使用できる照会パラメーターを示しています。
パラメーター | 「説明」 | 必須 | 値 |
---|---|---|---|
format | 取得する情報の形式を指定します。取り得る値は json または xml です。json 形式で情報を取得するには、次のとおり指定します:
|
いいえ | ストリング |
トークン | 固有のユーザー認証 ID。自分のトークンは、BigFix Inventory の「プロファイル」設定に表示できます。 | はい | 英数字 |
実行 | 実行するデータ・インポートのタイプを指定します。指定可能な値は以下のとおりです。
|
いいえ | ストリング |
HTTP 会話の例
- 要求
GET api/import_status.json ?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
- 応答の本文 (JSON)
- データ・インポートが一度も開始されていない場合:
{ "mode": "none", "can_run_imports": true, "import_status_url": "/import_status", "import_create_url": "/management/imports", }