apply-file-export

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 번호 get-data-box-frame-list 참조
`dataBoxNo`	Integer	Required	Data Box 번호 get-data-box-list 참조
`exportPurpose`	String	Required	반출 목적 1~1000자
`memo`	String	Optional	반출 신청에 대한 설명 0~50자
`sourceFileInfoList`	Array	Required	반출 신청 파일 정보 목록
`sourceNasInstanceNo`	Integer	Required	Source NAS 인스턴스 번호 get-source-nas-list 참조
`sslVpnNo`	Integer	Required	SSL VPN 번호 get-ssl-vpn-account-list 참조
`targetBucketName`	String	Required	Target 버킷 이름

`sourceFileInfoList`

sourceFileInfoList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`description`	String	Optional	반출 신청 파일에 대한 설명 1~1000자
`fileName`	String	Required	반출 신청 파일 이름 목록 한 번에 최대 5개 파일까지 반출 가능 개별 파일 크기: 10 MB 이하

요청 예시

요청 예시는 다음과 같습니다.

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	-	반출 신청 아이디
`dataBoxNo`	String	-	Data Box 번호
`dataBoxName`	String	-	Data Box 이름
`nasInstanceName`	String	-	Source NAS 인스턴스 이름
`sourceNasFileName`	String	-	반출 신청 파일 이름
`targetBucketName`	String	-	Target 버킷 이름
`status`	String	-	반출 신청 상태 코드 File Export Status Code 참조

응답 상태 코드

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