apply-file-export

Prev Next

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
dataBoxFrameNo Integer Required Data Box Frame番号
dataBoxNo Integer Required Data Box番号
exportPurpose String Required 持ち出しの目的
  • 1~1000文字
memo String Optional 持ち出し申請に関する説明
  • 0~50文字
sourceFileInfoList Array Required 持ち出し申請ファイル情報リスト
sourceNasInstanceNo Integer Required Source NASインスタンス番号
sslVpnNo Integer Required SSL VPN番号
targetBucketName String Required Targetバケット名

sourceFileInfoList

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

フィールド タイプ 必須の有無 説明
description String Optional 持ち出し申請ファイルに関する説明
  • 1~1000文字
fileName String Required 持ち出し申請ファイル名リスト
  • ファイルは一度に最大5つまで持ち出し可能
  • 個々のファイルサイズ: 10MB以下

リクエスト例

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

curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/export/apply-file-export' \
--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,
    "exportPurpose": "test",
    "memo": "export001",
    "sourceFileInfoList": [
        {
            "description": "export001",
            "fileName": "sample.xlsx"
        }
    ],
    "sourceNasInstanceNo": ********,
    "sslVpnNo": 776,
    "targetBucketName": "testddfdas"
}'

レスポンス

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

レスポンスボディ

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

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

content

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

フィールド タイプ 必須の有無 説明
exportApplyId Integer - 持ち出し申請 ID
dataBoxNo String - Data Box番号
dataBoxName String - Data Box名
nasInstanceName String - Source NASインスタンス名
sourceNasFileName String - 持ち出し申請ファイル名
targetBucketName String - Targetバケット名
status String - 持ち出し申請の状態コード

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

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

レスポンス例

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

{
    "totalCount": 1,
    "content": [
        {
            "exportApplyId": 1543,
            "dataBoxNo": "381",
            "dataBoxName": "BOX#1",
            "nasInstanceName": "nasw381n1",
            "sourceNasFileName": "sample.xlsx",
            "targetBucketName": "testddfdas",
            "status": "INIT"
        }
    ]
}