VPC環境で利用できます。
Data Box Frameは、分析者が顧客データを自由に分析し、データ管理者はデータの任意の持ち出しを制限できるようにサポートする NAVERクラウドプラットフォームの分析環境構築サービスです。Data Box Frameサービスは、ボックスフレームとデータボックスの作成、データの持ち込み・持ち出しの審査を行う APIをRESTful形式で提供します。
Data Box Frameの共通設定
Data Box Frame APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。
リクエスト
共通リクエスト形式を説明します。
API URL
リクエスト API URLは次の通りです。
https://databoxframe.apigw.ntruss.com
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
ヘッダ名 | 必須の有無 | 説明 |
---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名 |
x-ncp-lang |
Optional | レスポンスデータの多言語処理
|
サブアカウントでバケット関連の Data Box Frame APIを呼び出す場合、サブアカウントに Object Storageサービスの権限が必要な場合があります。
レスポンス
共通レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
error
errorは API呼び出し失敗情報を定義します。errorの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
error |
Object | - | エラーコードとメッセージ |
error.errorCode |
String | Required | エラーコード |
error.message |
String | Required | エラーメッセージ |
error.details |
String | Required | エラーメッセージの詳細説明 |
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
HTTPステータスコード | コード | メッセージ | 説明 |
---|---|---|---|
200 | - | - | 成功 |
400 | 10001 | - | リクエスト情報とパラメータエラー |
400 | 130*** | - | リクエスト情報とパラメータエラー |
401 | - | - | 無効な認証情報 |
403 | 10002 | - | 権限のないリクエスト |
404 | 10009 | - | 存在しないリソースまたはパス |
500 | 130000 | - | サービス内部エラー |
500 | 139999 | - | 連携サービス API呼び出しエラー |
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。
{
"error": {
"errorCode": "200",
"message": "Authentication Failed",
"details": "Invalid authentication information."
}
}
Data Box Frame API
Data Box Frameサービスが提供する APIの説明は次の通りです。
Data Box Frame
Data Box Frameに関連する APIは次の通りです。
API | 説明 |
---|---|
get-data-box-frame-list | Data Box Frameリストを照会 |
get-data-box-frame-detail | Data Box Frameの詳細情報を照会 |
get-data-box-frame-infra-list | Data Box Frameインフラリストを照会 |
modify-data-box-frame-admin-infra | Data Box Frameインフラ設定を変更 |
change-data-box-frame-nas-volume-size | Data Box Frame NAS容量を変更 |
return-data-box-frame | Data Box Frameを返却 |
Data Box
Data Boxに関連する APIは次の通りです。
API | 説明 |
---|---|
get-bucket-list | Data Box Frameの持ち込みまはた持ち出し時に使用するバケットリストを照会 |
create-data-box | Data Box Frameに Data Boxを作成 |
get-data-box-list | Data Box Frameの Data Boxリストを照会 |
get-data-box-summary-info | Data Box Frameの Data Boxサマリー情報を照会 |
get-data-box-infra-list | Data Box Frameの Data Boxインフラリストを照会 |
get-hadoop-cluster-info | Data Boxの Hadoopクラスタ情報を照会 |
get-linux-info | Data Boxの Linuxサーバ情報を照会 |
get-tensor-flow-info | Data Boxの TensorFlowサーバ情報を照会 |
change-data-box-nas-volume-size | Data Boxの NAS容量を変更 |
set-block-external-network | Data Boxの外部ネットワークを許可するかブロックするかを設定 |
modify-data-box | Data Boxインフラ設定を変更 |
return-data-box | Data Boxを返却 |
Import
ファイル持ち込みに関連する APIは次の通りです。
API | 説明 |
---|---|
get-target-nas-list | Data Boxへの持ち込みファイルを保存する NASリストを照会 |
apply-file-import | Data Boxへのファイル持ち込みを申請 |
get-import-apply-list | Data Boxへのファイル持ち込み申請リストを照会 |
get-import-apply-detail | Data Boxへのファイル持ち込み申請の詳細情報を照会 |
Export
ファイル持ち出しに関連する APIは次の通りです。
API | 説明 |
---|---|
get-ssl-vpn-account-list | Data Boxに登録されている SSL VPNアカウントリストを照会 |
get-source-nas-list | Data Boxからの持ち出し申請ファイルが保存されている NASリストを照会 |
apply-file-export | Data Boxからファイル持ち出しを申請 |
get-export-apply-list | Data Boxからのファイル持ち出し申請リストを照会 |
get-export-apply-detail | Data Boxからのファイル持ち出し申請リストの詳細情報を照会 |
return-file-export-apply | Data Boxからのファイル持ち出し申請をキャンセル |
Approve
ファイル持ち出し審査に関連する APIは次の通りです。
API | 説明 |
---|---|
get-export-file-approve-list | Data Boxからの持ち出し審査対象リストを照会 |
get-export-file-approve-detail | Data Boxからの持ち出し審査対象の詳細情報を照会 |
export-file-approve | Data Boxからファイル持ち出し申請を承認 |
export-file-reject | Data Boxからのファイル持ち出し申請を却下 |
Data Box Frame関連リソース
Data Box Frame APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
- Data Box Frame APIの使用方法
- 署名(シグネチャー)の作成: リクエストヘッダに追加する署名の作成方法
- API Gatewayご利用ガイド: リクエストヘッダに追加する API Keyを発行
- Sub Accountご利用ガイド: リクエストヘッダに追加する Access Keyの発行方法
- Ncloudの共通レスポンスステータスコード: Data Box Frameサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
- Data Box Frameサービスの使用方法
- Data Box Frameご利用ガイド: NAVERクラウドプラットフォームコンソールで Data Box Frameを使用する方法
- Ncloud使用環境ガイド: VPC、Classic環境とサポートの有無に関するご利用ガイド
- 料金の紹介、特徴、詳細機能: Data Box Frameの料金体系、Data Box Frameの特徴と詳細機能、活用例のサマリー
- サービスのお知らせ: Data Box Frameに関するお知らせ
- よくある質問: Data Box Frameに関するよくあるご質問
- お問い合わせ: ご利用ガイドだけでは不明な点が解消されない場合、直接お問い合わせ