apply-file-import

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

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

`fileList`

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

フィールド	タイプ	必須の有無	説明
`name`	String	Required	ファイル名拡張子を含めてバケットに登録されている名前と同じ名前を入力最大5つ入力可能ファイルごとの容量: 500MB以内

リクエスト例

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

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": ****,
    "bucketName": "testddfdas",
    "fileList": [
        {
            "name": "Glossary_2.xlsx"
        },
        {
            "name": "Glossary_3.xlsx"
        }
    ],
    "nasInstanceNo": ********
}'

レスポンス

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

レスポンスボディ

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

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

content

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

フィールド	タイプ	必須の有無	説明
`importNo`	Integer	-	持ち込み申請番号
`nasInstanceNo`	Integer	-	ターゲット NASのインスタンス番号
`bucketName`	String	-	ソースバケット名
`nasName`	String	-	ターゲット NASの名前
`fileName`	String	-	持ち込みファイル名
`statusCode`	String	-	持ち込み状態コード `INIT` \| `ING` \| `SCSS` \| `ERR_FILE` \| `ERR_SYS` \| `ERR_SEC` `INIT`: 持ち込み申請(ファイル転送前) `ING`: 転送中 `SCSS`: 持ち込み完了 `ERR_FILE`: 失敗(ファイルエラー) `ERR_SYS`: 失敗(システムエラー) `ERR_SEC`: 失敗(ファイルセキュリティ検査失敗)
`status`	String	-	持ち込みの状態
`applyDate`	String	-	申請日時

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

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

レスポンス例

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

{
    "totalCount": 2,
    "content": [
        {
            "importNo": 3292,
            "nasInstanceNo": ********,
            "bucketName": "testddfdas",
            "nasName": "nasw1",
            "fileName": "Glossary_3.xlsx",
            "statusCode": "INIT",
            "status": "持ち込みの申請(ファイル転送前)",
            "applyDate": "2025-03-04 10:26:57"
        },
        {
            "importNo": 3291,
            "nasInstanceNo": ********,
            "bucketName": "testddfdas",
            "nasName": "nasw1",
            "fileName": "Glossary_2.xlsx",
            "statusCode": "INIT",
            "status": "持ち込みの申請(ファイル転送前)",
            "applyDate": "2025-03-04 10:26:57"
        },
        {
            "importNo": 3288,
            "nasInstanceNo": ********,
            "bucketName": "testddfdas",
            "nasName": "nasw1",
            "fileName": "Glossary_1.xlsx",
            "statusCode": "SCSS",
            "status": "持ち込み完了",
            "applyDate": "2025-03-04 08:48:30"
        }
    ]
}