---
title: "get-box-list"
slug: "get-box-list"
updated: 2026-09-17T09:16:07Z
published: 2026-09-17T09:16:07Z
canonical: "api.ncloud-docs.com/get-box-list"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# get-box-list

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

Box 목록을 조회합니다.

## 요청

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

| 메서드 | URI |
| --- | --- |
| GET | /api/v1/box/get-box-list |

### 요청 헤더

Datafence API에서 공통으로 사용하는 헤더에 대한 정보는 [Datafence 요청 헤더](/docs/datafence-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.

### 요청 쿼리 파라미터

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `fenceId` | Integer | Required | Datafence 번호 - [get-datafence](/docs/get-datafence) 참조 |
| `page` | Integer | Optional | 페이지 번호 - 0~100 (기본값: 0) |
| `size` | Integer | Optional | 페이지당 항목 수 - 1~100 (기본값: 10) |

### 요청 예시

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

```
curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-list?fenceId=26&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](/docs/get-box-list#content) |

#### `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 포함) |

### 응답 상태 코드

Datafence API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Datafence API 응답 상태 코드](/docs/datafence-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.

### 응답 예시

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

```
{
    "totalCount": 1,
    "content": [
        {
            "boxId": 74,
            "boxName": "box1",
            "description": "",
            "statusCode": "USE",
            "statusName": "이용중",
            "createDate": "2025-04-21T11:24:01+09:00"
        }
    ]
}
```