apply-file-import

Prev Next

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
dataBoxFrameNo Integer Required Data Box Frame番号
dataBoxNo Integer Required Data Box番号
memo String Optional 持ち込み申請に関する説明
  • 1~50文字
sourceBucketName String Required Sourceバケット名
sourceFileInfoList Array Required 持ち込みファイル情報リスト
targetNasInstanceNo Integer Required Target NASインスタンス番号

sourceFileInfoList

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

フィールド タイプ 必須の有無 説明
fileName String Required 持ち込みファイル名リスト
  • ファイルは一度に最大5つまで持ち込み可能
  • 個々のファイルサイズ: 500MB以下

リクエスト例

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

curl --location --request POST 'https://databoxframe.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 '{
  "dataBoxFrameNo": 83,
  "dataBoxNo": 381,
  "memo": "dbf001",
  "sourceBucketName": "testddfdas",
  "sourceFileInfoList": [
    {
      "fileName": "sample.xlsx"
    }
  ],
  "targetNasInstanceNo": *********
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
totalCount Integer - レスポンス結果数
importApplyId String - 持ち込み申請 ID
dataBoxNo String - Data Box番号
dataBoxName String - Data Box名
nasInstanceName String - Target NAS名
sourceBucketName String - Sourceバケット名
sourceBucketFileName String - 持ち込みファイル名
status String - 持ち込みの状態コード

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

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

レスポンス例

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

{
    "totalCount": 1,
    "content": [
        {
            "importApplyId": 881,
            "dataBoxNo": "381",
            "dataBoxName": "BOX#1",
            "nasInstanceName": "nasw381n1",
            "sourceBucketName": "testddfdas",
            "sourceBucketFileName": "sample.xlsx",
            "status": "INIT"
        }
    ]
}