Datafenceの概要

Prev Next

VPC環境で利用できます。

Datafenceは、分析者が顧客データを自由に分析し、データ管理者はデータの任意の持ち出しを制限できるようにサポートする NAVERクラウドプラットフォームの分析環境構築サービスです。Datafenceサービスは、Datafenceとボックスの作成、データの持ち込み・持ち出しの審査を行う APIをRESTful形式で提供します。

Datafenceの共通設定

Datafence APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://datafence.apigw.ntruss.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

ヘッダ名 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • Unix Timestamp形式
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 レスポンスデータの多言語処理
  • ko-KR | en-US (デフォルト) | zh-CN
    • ko-KR: 韓国語
    • en-US: 英語
    • zh-CN: 中国語(簡体字)
参考

サブアカウントでバケット関連の Datafence 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 2600003 - Datafence(または Box)の所有者ではない
400 2600005 - リクエストした外部ネットワーク設定が現在と同じ状態
400 2600010 - Box内サーバの再起動状態
400 2600011 - Boxの作成数制限を超過
400 2600013 - 無効なパスワード
400 2600023 - Datafence内に Boxが少なくとも1つ必要
400 2600024 - Boxが変更できない状態
400 2600025 - Datafenceが使用できない状態
400 2600026 - 無効な Action Type
400 2600029 - バケットが存在しない
400 2600031 - リクエストしたサーバ数が許容範囲外
400 2600033 - リクエストした Hadoopブロックストレージ容量が許容範囲外
400 2600035 - 無効なストレージインスタンスまたは NASインスタンス番号
400 2600038 - リクエストした NASが許容範囲外
400 2600040 - 変更後の NAS容量が変更前と同じ
400 2600041 - Boxにサーバが存在しない
400 2600047 - Boxストレージが存在しない
400 2600053 - Datafenceが存在しない
400 2600054 - Boxが存在しない
400 2600072 - 無効なスペックコード
400 2600073 - 無効なソフトウェアコード
400 2610001 - 無効な持ち出し申請番号
400 2610002 - 申請したファイル名が重複している
400 2610004 - 最大申請数超過
400 2610006 - ファイルサイズ超過
400 2610008 - 無効なファイル名
400 2610010 - 既に承認済みの持ち出し申請
400 2610012 - 申請したファイルが見つからない
403 10002 - 権限のないリクエスト
404 10003 - 存在しないリソース
500 10007 - サービス内部エラー
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "error": {
        "errorCode": "200",
        "message": "Authentication Failed",
        "details": "Invalid authentication information."
    }
}

Datafence API

Datafenceサービスが提供する APIの説明は次の通りです。

Datafence

Datafenceに関連する APIは次の通りです。

API 説明
get-datafence Datafenceリストを照会
get-datafence-infra-history Datafenceのインフラ履歴を照会
get-datafence-infra-list Datafenceのインフラリストを照会
get-fence-custom-image Datafenceのユーザーイメージを照会
change-datafence-infra Datafenceのインフラ設定を変更
change-fence-nas-volume Datafence NAS容量を変更

Box

Boxに関連する APIは次の通りです。

API 説明
get-bucket-list Datafenceの持ち込みまはた持ち出し時に使用するバケットリストを照会
get-product-spec Boxスペックリストを照会
create-box Datafenceに Boxを作成
get-box-custom-image Box内ユーザーイメージを照会
get-box-history Datafenceの Box履歴を照会
get-box-infra-history Datafenceの Boxインフラ履歴を照会
get-box-infra-list Datafenceの Boxインフラリストを照会
get-box-list Datafenceの Boxリストを照会
get-box-summary-info Datafenceの Boxのサマリー情報を照会
get-connect-info Boxの Connectサーバ情報を照会
get-hadoop-cluster-info Boxの Hadoopクラスタ情報を照会
get-linux-info Boxの Linuxサーバ情報を照会
get-windows-info Boxの Windows Server情報を照会
get-tensorflow-info Boxの TensorFlowサーバ情報を照会
change-box-block-external-network Boxの外部ネットワークを許可するかブロックするかを設定
change-box-infra Boxのインフラ設定を変更
change-box-nas-volume Boxの NAS容量を変更
return-box Boxを返却

Import

ファイル持ち込みに関連する APIは次の通りです。

API 説明
create-file-import Boxへのファイル持ち込みを申請
get-import-detail Boxへのファイル持ち込み申請の詳細情報を照会
get-import-list Boxへのファイル持ち込み申請リストを照会
get-target-nas-list Boxへの持ち込みファイルを保存する NASリストを照会

Export

ファイル持ち出しに関連する APIは次の通りです。

API 説明
create-file-export Boxからファイル持ち出しを申請
get-export-detail Boxからの持ち出し申請リストの詳細情報を照会
get-export-list Boxからのファイル持ち出し申請リストを照会
get-source-nas-list Boxからの持ち出し申請ファイルが保存されている NASリストを照会
cancel-file-export Boxからのファイル持ち出し申請をキャンセル

Export Approval

ファイル持ち出し審査に関連する APIは次の通りです。

API 説明
get-export-file-approve-detail Boxからのファイル持ち出し審査対象の詳細情報を照会
get-export-file-approve-list Boxからのファイル持ち出し審査対象リストを照会
export-file-approve Boxからのファイル持ち出し申請を承認
export-file-reject Boxからのファイル持ち出し申請を却下

Datafence関連リソース

Datafence APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。