apply-file-export

VPC環境で利用できます。

データボックスのファイルを Object Storageのバケットにエクスポートするためにファイルの持ち出しを申請します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/export/apply-file-export

リクエストヘッダ

Cloud Data Box APIで共通して使用されるヘッダの詳細は、Cloud Data Boxのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`dataBoxNo`	Integer	Required	データボックス番号 NAVERクラウドプラットフォームコンソールの My Spaceメニューで [サーバの詳細情報を見る] ボタンをクリックすると表示されるインフラタブメニュー画面でサーバ名に共通して表示される数字データボックスの詳細情報を確認する方法: Cloud Data Boxご利用ガイドを参照
`nasInstanceNo`	Integer	Required	ソース NASインスタンス番号 get-nas-listを参照
`bucketName`	String	Required	ターゲットバケット名 get-bucket-listを参照
`fileList`	Array	Required	持ち出しファイル情報

`fileList`

fileListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	持ち出しファイル名
`description`	String	Required	持ち出しファイルの説明(文字) 30~N 持ち出し審査の根拠となるため、データ持ち出しの基準に準拠して入力
`type`	String	Required	持ち出しファイルのタイプ `TABLE` \| `IMAGE` \| `MODEL` \| `LICENCE` `TABLE`: 区切り文字で区切られたテキスト `IMAGE`: 画像 `MODEL`: 分析モデル `LICENCE`: ライセンス
`tableDetail`	String	Conditional	テーブルファイルのフィールド区切り文字 `TAB` \| `SPACE` \| `COMMA` \| `CUSTOM` `TAB`: タブ `SPACE`: スペース `COMMA`: コンマ `CUSTOM`: ユーザー定義
`delimiter`	String	Conditional	ユーザー定義区切り文字 `tableDetail`が`CUSTOM`の場合、必ず入力
`imageDetail`	String	Conditional	画像ファイル拡張子 `BMP` \| `GIF` \| `JPEG` \| `TIFF` `BMP`: bmpファイル `GIF`: gifファイル `JPEG`: jpegファイル `TIFF`: tiffファイル `type`が`IMAGE`の場合、必ず入力
`modelDetail`	String	Conditional	分析モデル形式 `TENSORFLOW` \| `PYTORCH` \| `SCIKIT_LEARN` \| `R` `TENSORFLOW`: TensorFlowファイル `PYTORCH`: PyTorchファイル `SCIKIT_LEARN`: scikit-learnファイル `R`: Rファイル `type`が`MODEL`の場合、必ず入力
`modelVersion`	String	Conditional	分析モデルのバージョン `type`が`MODEL`の場合、必ず入力

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://databox.apigw.ntruss.com/api/v1/import/apply-file-import' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
    "dataBoxNo": ****,
    "nasInstanceNo": ********,
    "bucketName": "bckt111",
    "fileList": [
        {
            "name": "T1_member.txt",
            "description": "テスト用のメンバーリストファイルです。ID: 任意のシリアル番号。名前: 仮想人物の名前。職責: 仮想の職責を付与。部署: 仮想の部署を割り当て",
            "type": "TABLE",
            "tableDetail": "TAB"
        }
    ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`totalCount`	Integer	-	レスポンス結果数
`content`	Array	-	持ち出し申請情報

`content`

contentの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`exportNo`	Integer	-	持ち出し申請番号
`nasInstanceNo`	Integer	-	ソース NASのインスタンス番号
`bucketName`	String	-	ターゲットバケット名
`nasName`	String	-	ソース NAS名
`fileName`	String	-	持ち出しファイル名
`status`	String	-	持ち出し状態 `審査のリクエスト(ファイル転送前)` \| `審査のリクエスト(ファイル転送中)` \| `審査のリクエスト(ファイル転送完了)` \| `承認(バケット転送中)` \| `承認(バケット転送完了)` \| `却下` `審査のリクエスト(ファイル転送前)`: 審査用 Object Storageにファイル転送準備 `審査のリクエスト(ファイル転送中)`: 審査用 Object Storageにファイルを転送 `審査のリクエスト(ファイル転送完了)`: 審査用 Object Storageにファイル転送完了 `承認(バケット転送中)`: 持ち出し承認後にターゲットバケットにファイルを転送 `承認(バケット転送完了)`: 持ち出し承認後にターゲットバケットにファイルを転送完了 `却下`: 持ち出し審査で却下

レスポンスステータスコード

Cloud Data Box APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Data Boxのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "totalCount": 1,
    "content": [
        {
            "exportNo": 3294,
            "nasInstanceNo": ********,
            "bucketName": "bckt111",
            "nasName": "nasw1",
            "fileName": "T1_member.txt",
            "status": "審査のリクエスト(ファイル転送前)"
        }
    ]
}