レポートAPI (v3) の一覧
inSync Cloud Editions: Elite Plus
Elite
Enterprise
Business
inSyncが提供するレポートAPIバージョン3に関する情報を記します。
概要
このトピックでは、読み取り専用モードで使用可能なレポートAPIに関する情報を提供します。レポートAPIを使用して情報を取得する場合、情報は次の表記法で取得されます。
- 割当量設定、データ使用量などサイズに関連するアトリビュートはMB (メガバイト) で表示されます。
- すべての日付はmm/dd/yy hh:mmフォーマットで表示されます。
注意: 本文書内の 'datasource (データソース)' とは、n this article refers to both,バックアップ対象に設定されたエンドポイントとクラウドアプリの両方のアカウントを示します。
前提条件
使用方法についてはレポートAPIを参照してください。
レポートAPIの一覧
ここでは利用可能なAPIの一覧を示します。
User List API
-
- 説明 - inSync内のすべてのユーザーに関する情報を取得します
- リクエスト: GET /api/reports/v3/users HTTP/1.1
- リクエストヘッダー: Authorization = <LOGIN CREDENTIALS>
- レスポンス (JSON):
- HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
- HTTP/1.1 200 : {"data":[{"Profile":"default"}...]}
User List APIを使用したときに取得される属性を以下にまとめます。
属性 説明 user_name ユーザーの名前です。 email_id ユーザーのメールアドレスです。 added_on ユーザーが追加された日時です。 profile 当該ユーザーに割り当てられたプロファイルです。 total_usage MB単位でユーザにより消費されたディスク容量です。 user_status ユーザーのステータスです。たとえば、 “enabled (有効)” です。 allocated_quota MB単位でユーザーに割り当てられた割当量 (ディスク容量) です。 storage 当該ユーザーのデータが保存されるストレージの名前です。 user_id inSync内のユーザーのユニークIDです。
Device List API
-
- 説明 - inSync内のすべてのデバイスに関する情報を取得します
- リクエスト: GET /api/reports/v3/devices HTTP/1.1
- リクエストヘッダー: Authorization = <LOGIN CREDENTIALS>
- レスポンス (JSON):
- HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
- HTTP/1.1 200 : {"data":[{"first_backup_size": "1029.46"}...]}
Device List APIを使用したときに取得される属性を以下にまとめます。
属性 説明 email_id ユーザーのメールアドレスです。 device_name 当該ユーザーで登録されたデバイスの名前です。 device_status デバイスのステータスです。たとえば、 “activated” です。 client_version inSyncクライアントのバージョンです。 OS_platform ユーザーデバイスのプラットフォームです。 last_upgrade_on デバイスが前回アップグレードされた日時です。 device_OS ユーザーデバイスのオペレーティングシステムです。 Upgrade_state デバイスアップグレードステータスです。 added_on デバイスが追加された日時です。 first_backup_status 最初のバックアップ操作のステータスです。 total_backup_data MB単位で当該デバイスに対してバックアップされたデータの合計サイズです。合計サイズは当該デバイスに対する増分および差分バックアップデータ量の合計値です。 first_backup_size MB単位で当該デバイスに対して最初にバックアップされたデータのサイズです。 system_settings_backed_up デバイスのシステム設定がバックアップされたかどうかのステータスです。 serial_number 製造元で個々のハードウェアに割り当てられたユニークな識別番号です。 uuid インターネット上のデバイスをユニークに識別するために使用される128ビットの数値です。 user_id inSync内のユーザーのユニークIDです。 device_id inSync内のユーザーデバイスのユニークIDです。 Note: serial_number と uuid パラメータは以下の場合には使用できません。
- タブレット、モバイル端末
- Linux OSで動作するデバイス
- inSync クライアント 5.9以前のデバイス
Last Backup Details API
-
- 説明 - inSync内の各デバイスに関する最終バックアップの情報を取得します
- リクエスト: GET /api/reports/v3/lastbackupdetails HTTP/1.1
- リクエストヘッダー: Authorization = <LOGIN CREDENTIALS>
- レスポンス (JSON):
- HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
- HTTP/1.1 200 : {"data":[{"backup_start_time": "01/20/16 19:12"}...]}
Last Backup Details APIを使用したときに取得される属性を以下にまとめます。
属性 説明 email_id ユーザーのメールアドレスです。 device_name バックアップが実施されたデバイスの名前です。 last_backup_status バックアップ操作のステータスです。 bytes_transferred バックアップ中に転送されたバイト量です。 backup_data MB単位で最終バックアップ操作中にバックアップされたファイルのサイズです。 OS_platform ユーザーデバイスのプラットフォームです。 device_OS ユーザーデバイスのオペレーティングシステムです。 files_missed 最終バックアップで失敗したファイル数です。 files_backed_up バックアップされたファイル数です。 system_settings_backed_up デバイスのシステム設定がバックアップされたかどうかのステータスです。 backup_start_time バックアップが開始されたときの日時です。 backup_end_time バックアップが完了したときの日時です。 serial_number 製造元で個々のハードウェアに割り当てられたユニークな識別番号です。 uuid インターネット上のデバイスをユニークに識別するために使用される128ビットの数値です。 last_connected デバイスが inSync サーバーに最後に接続した日時です。 user_id inSync内のユーザーのユニークIDです。 device_id inSync内のユーザーデバイスのユニークIDです。 Note: serial_number と uuid パラメータは以下の場合には使用できません。
- タブレット、モバイル端末
- Linux OSで動作するデバイス
- inSync クライアント 5.9以前のデバイス
First Backup Details API
-
- 説明 - inSync内の各デバイスに関する初回バックアップの情報を取得します
- リクエスト: GET /api/reports/v3/firstbackupdetails HTTP/1.1
- リクエストヘッダー: Authorization = <LOGIN CREDENTIALS>
- レスポンス (JSON):
- HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
- HTTP/1.1 200 : {"data":[{"system_settings_backed_up": "Not Backed Up"}...]}
First Backup Details APIを使用したときに取得される属性を以下にまとめます。
属性 説明 email_id ユーザーのメールアドレスです。 device_name バックアップが実施されたデバイスの名前です。 client_version inSyncクライアントのバージョンです。 OS_platform ユーザーデバイスのプラットフォームです。 last_upgrade_on デバイスが前回アップグレードされた日時です。 device_OS ユーザーデバイスのオペレーティングシステムです。 Upgrade_state デバイスアップグレードステータスです。 first_backup_status 初回バックアップ操作のステータスです。 first_backup_size デバイスの初回バックアップサイズです。 system_settings_backed_up デバイスのシステム設定がバックアップされたかどうかのステータスです。 time_taken 初回バックアップが完了するまでにかかった時間です。 serial_number 製造元で個々のハードウェアに割り当てられたユニークな識別番号です。 uuid インターネット上のデバイスをユニークに識別するために使用される128ビットの数値です。 user_id inSync内のユーザーのユニークIDです。 device_id inSync内のユーザーデバイスのユニークIDです。 Note: serial_number と uuid パラメータは以下の場合には使用できません。
- タブレット、モバイル端末
- Linux OSで動作するデバイス
- inSync クライアント 5.9以前のデバイス
Share Details API
-
Note: このAPIを使用する場合、inSync Shareが有効である必要があります。
- 説明 - Retrieves information on usage of inSync Share by each user in inSync.
- リクエスト: GET /api/reports/v3/sharedetails HTTP/1.1
- リクエストヘッダー: Authorization = <LOGIN CREDENTIALS>
- レスポンス (JSON):
- HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
- HTTP/1.1 200 : {"data":[{"email_id": "ernie.carter@druva.com"}...]}
Share Details APIを使用したときに取得される属性を以下にまとめます。
属性 説明 email_id ユーザーのメールアドレスです。 total_files 当該ユーザーにより共有されたファイルの合計数です。 shared_folders 当該ユーザーにより共有されたフォルダー数です。 links データ共有のために当該ユーザーにより作成されたリンクの数です。 email_id ユーザーのメールアドレスです。 user_id inSync内のユーザーのユニークIDです。
Restore Details API
-
- 説明 - inSync内で実行された復元に関する情報を取得します
- リクエスト: GET /api/reports/v3/restoredetails HTTP/1.1
- リクエストヘッダー: Authorization = <LOGIN CREDENTIALS>
- レスポンス (JSON):
- HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
- HTTP/1.1 200 : {"data":[{"restore_end_time": "02/18/16 13:34"}...]}
Restore Details APIを使用したときに取得される属性を以下にまとめます。
属性 説明 email_id ユーザーのメールアドレスです。 device_name 復元が実施されたデバイスの名前です。 no_of_files 復元されたファイル数です。 system_settings_restore デバイスのシステム設定が復元されたかどうかのステータスです。 restore_status 実施された復元操作のステータスです。 restore_size MB単位で復元された合計サイズです。 restore_start_time 復元が開始されたときの日時です。 restore_end_time 復元が完了したときの日時です。 mode 開始された復元操作のモードです。モードには以下の種類があります。
- ユーザーが開始した復元 (User initiated restore)
- 管理者が開始した復元 (Administrator initiated restore)
- inSync Web経由でユーザーが開始した復元
- モバイルアプリ経由でユーザーが開始した復元
serial_number 製造元で個々のハードウェアに割り当てられたユニークな識別番号です。 uuid インターネット上のデバイスをユニークに識別するために使用される128ビットの数値です。 user_id inSync内のユーザーのユニークIDです。 device_id inSync内のユーザーデバイスのユニークIDです。 Note: serial_number と uuid パラメータは以下の場合には使用できません。
- タブレット、モバイル端末
- Linux OSで動作するデバイス
- inSync クライアント 5.9以前のデバイス
Cloud Storage Details API
-
- 説明 - 組織で使用されたストレージに関する情報を取得します
- リクエスト: GET /api/reports/v3/storages HTTP/1.1
- リクエストヘッダー: Authorization = <LOGIN CREDENTIALS>
- レスポンス (JSON):
- HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
- HTTP/1.1 200 : {"data":[{"storage_usage": "125.40"}...]}
Cloud Storage Details APIを使用したときに取得される属性を以下にまとめます。
属性 説明 storage_name ストレージの名前です。 no_of_users 当該ストレージに割り当てられたユーザー数です。 total_size_of_backed_up_files MB単位でストレージへのデータのバックアップで消費された容量です。 storage_usage 当該ストレージ上でバックアップされたデータの合計サイズです。
CloudCache Details API
-
- 説明 - 組織のinSync CloudCacheサーバー使用状況に関する情報を取得します
- リクエスト: GET /api/reports/v3/cloudcachedetails HTTP/1.1
- リクエストヘッダー: Authorization = <LOGIN CREDENTIALS>
- レスポンス (JSON):
- HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
- HTTP/1.1 200 : {"data":[{"cache_usage": "151.00"}...]}
CloudCache Details APIを使用したときに取得される属性を以下にまとめます。
属性 説明 cloudcache_name CloudCacheサーバーの名前です。 no_of_users 当該ストレージに割り当てられたユーザー数です。 no_of_users_for_restore 復元準備が完了しているユーザー数です。 total_cache_size キャッシュデータ用に利用可能な合計ディスク容量です。 cache_usage 当該時点までに消費されたキャッシュデータの合計ディスク容量です。
Inactive Devices API
- 説明 - Retrieves information on inactive devices, last backup, last server connectivity, and device delete date.
- リクエスト: GET /api/reports/v3/
inactivedevicesdetails HTTP/1.1 - リクエストヘッダー: Authorization = <LOGIN CREDENTIALS>
- レスポンス (JSON):
- HTTP/1.1 4XX/5XX : { 'errno': , 'desc': }
- HTTP/1.1 200 : {"data":[{"last_backup_date": "May 05 2017 03:15"}...]}
属性 | 説明 |
---|---|
last_backup_date | デバイスから最終バックアップされた日時です。 |
email_id | ユーザーのメールアドレスです。 |
auto_delete_on |
デバイスが自動削除される日時です。 この属性のデータは、非アクティブデバイスの自動削除機能が有効な場合に使用できます。この機能を有効にするには、Druva Supportまでお問い合わせください。非アクティブであるユーザーデバイスは、デフォルトではinSync管理コンソールから削除されません。 |
profile_name | 当該ユーザーに割り当てられたプロファイルです。 |
user_status | ユーザーのステータスです。たとえば、 “enabled (有効)” です。 |
uuid | インターネット上のデバイスをユニークに識別するために使用される128ビットの数値です。 |
last_connected | デバイスが inSync サーバーに最後に接続した日時です。 |
device_status | デバイスのステータスです。たとえば、 “activated” です。 |
device_name | inSyncで登録されたデバイスの名前です。 |
serial_number | 製造元で個々のハードウェアに割り当てられたユニークな識別番号です |
user_name | The name of the user associated with the device. |
user_id | inSync内のユーザーのユニークIDです。 |
device_id | inSync内のユーザーデバイスのユニークIDです。 |
Note: uuid と serial_number パラメータの定義は Windows と Mac で異なります。詳細は以下を参照してください。