get-box-history

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

Box 이력을 조회합니다.

요청

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

메서드	URI
GET	/api/v1/box/get-box-history

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`fenceId`	Integer	Required	Datafence 번호
`page`	Integer	Optional	페이지 번호 0~100
`size`	Integer	Optional	페이지당 항목 수 1~100

요청 예시

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-history?fenceId=1&page=1&size=10' \
--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	-	Box 이력 목록

`content`

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

필드	타입	필수 여부	설명
`boxId`	Integer	-	Box 번호
`boxName`	String	-	Box 이름
`description`	String	-	Box에 대한 설명
`statusCode`	String	-	Box 상태 코드 `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: 인프라 생성 중 `USE`: 이용 중 `ING`: 변경 중 `RETURN`: 반납 중 `TERMINATE`: 반납 완료
`statusName`	String	-	Box 상태 이름 `인프라 생성중` \| `이용중` \| `변경 중` \| `반납중` \| `반납완료`
`createDate`	String	-	Box 생성 일시 ISO 8601 형식(UTC+9 포함)
`endDate`	String	-	Box 반납 일시 ISO 8601 형식(UTC+9 포함)

응답 상태 코드

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

응답 예시

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

{
  "totalCount": 7,
  "content": [
    {
      "boxId": "-",
      "boxName": "box7",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "반납완료",
      "createDate": "2025-03-18T17:42:43+09:00",
      "endDate": "2025-03-19T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box6",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "반납완료",
      "createDate": "2025-03-05T17:33:25+09:00",
      "endDate": "2025-03-10T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box5",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "반납완료",
      "createDate": "2025-03-05T15:29:22+09:00",
      "endDate": "2025-03-09T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box4",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "반납완료",
      "createDate": "2025-02-26T10:35:03+09:00",
      "endDate": "2025-03-01T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box3",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "반납완료",
      "createDate": "2025-02-18T11:56:40+09:00",
      "endDate": "2025-02-20T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box2",
      "description": "-",
      "statusCode": "TERMINATE",
      "statusName": "반납완료",
      "createDate": "2025-01-09T15:16:35+09:00",
      "endDate": "2025-01-12T18:42:43+09:00"
    },
    {
      "boxId": "-",
      "boxName": "box1",
      "description": "-",
      "statusCode": "USE",
      "statusName": "이용중",
      "createDate": "2025-01-09T13:51:10+09:00"
    }
  ]
}