get-import-list

Prev Next

VPC 환경에서 이용 가능합니다.

Box 내 파일 반입 신청 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /api/v1/import/get-import-list

요청 헤더

Datafence API에서 공통으로 사용하는 헤더에 대한 정보는 Datafence 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
fenceId Integer Required Datafence 번호
boxId Integer Required Box 번호
status String Optional 반입 신청 상태 코드
from String Optional 조회 시작 일시
  • yyyyMMddHHmmss 형식
to String Optional 조회 종료 일시
  • yyyyMMddHHmmss 형식
page Integer Optional 페이지 번호
  • 0~100 (기본값: 0)
size Integer Optional 페이지당 항목 수
  • 1~100 (기본값: 10)

요청 예시

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/import/get-import-list?fenceId=26&boxId=74&status=IMPORTED&from=20250401000000&to=20250430000000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
totalCount Integer - 응답 결과 수
content Array 반입 신청 목록

content

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

필드 타입 필수 여부 설명
fileId Integer - 반입 신청 번호
fenceId Integer - Datafence 번호
boxId Integer - Box 번호
boxName String - Box 이름
description String - 반입 신청에 대한 설명
sourceBucketName String - Source 버킷 이름
sourceFilePath String - 반입 신청 대상 파일 이름
targetNasName String - Target NAS 이름
statusCode String - 반입 신청 상태 코드
statusName String - 반입 신청 상태 이름
createDate String - 반입 신청 일시
  • ISO 8601 형식(UTC+9 포함)
completeDate String - 반입 완료 일시
  • ISO 8601 형식(UTC+9 포함)

응답 상태 코드

Datafence API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Datafence API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "totalCount": 3,
    "content": [
        {
            "fileId": 113,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "sourceBucketName": "test-bucket-for-fence",
            "sourceFilePath": "archive3.zip",
            "targetNasName": "74box1",
            "description": "파일 반입 요청",
            "statusCode": "INITIALIZED",
            "statusName": "반입요청(파일 전송전)",
            "createDate": "2025-04-25T11:22:07+09:00"
        },
        {
            "fileId": 112,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "sourceBucketName": "test-bucket-for-fence",
            "sourceFilePath": "archive2.zip",
            "targetNasName": "74box1",
            "description": "파일 반입 요청",
            "statusCode": "UPLOADING",
            "statusName": "반입요청(파일 전송중)",
            "createDate": "2025-04-25T11:22:07+09:00"
        },
        {
            "fileId": 111,
            "fenceId": 26,
            "boxId": 74,
            "boxName": "box1",
            "sourceBucketName": "test-bucket-for-fence",
            "sourceFilePath": "archive.zip",
            "targetNasName": "74box1",
            "description": "파일 반입 요청",
            "statusCode": "IMPORTED",
            "statusName": "반입완료",
            "createDate": "2025-04-25T11:22:07+09:00",
            "completeDate": "2025-04-25T11:22:44+09:00"
        }
    ]
}