create-file-export

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`fenceId`	Integer	Required	Datafence番号 get-datafenceを参照
`boxId`	Integer	Required	Box番号 get-box-listを参照
`sourceNasInstanceNo`	Integer	Required	Source NASインスタンス番号 get-source-nas-listを参照
`sourceFilePathList`	List	Required	持ち出し申請ファイル名リスト同時持ち出し申請可能なファイル数: 10個ファイル1個当たりの最大サイズ: 2GB ファイル名: {持ち込み番号(`fileId`)}_{Sourceファイル名(`sourceFilePath`)}に指定 get-import-listを参照
`targetBucketName`	String	Required	Targetバケット名
`fileDescription`	String	Required	持ち出し申請ファイルに関する説明 1~1000文字
`exportPurpose`	String	Required	持ち出しの目的 1~1000文字
`description`	String	Required	持ち出し申請に関する説明 0~50文字

リクエスト例

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

curl --location --request POST 'https://datafence.apigw.ntruss.com/api/v1/export/create-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 '{
  "fenceId": 26,
  "boxId": 74,
  "sourceNasInstanceNo": ********,
  "sourceFilePathList": ["108_datafence001.csv"],
  "targetBucketName": "test-bucket-for-fence",
  "fileDescription": "テスト用ファイル",
  "exportPurpose": "ファイル持ち出しテスト",
  "description": "ファイル持ち出しテスト"
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`message`	String	-	API処理結果メッセージ

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

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

レスポンス例

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

{
    "message": "File export requested."
}