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."
}