---
title: "get-box-list"
slug: "get-box-list"
updated: 2026-09-17T09:57:32Z
published: 2026-09-17T09:57:32Z
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/ja/datafence-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `fenceId` | Integer | Required | Datafence番号 - [get-datafence](/docs/ja/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/ja/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/ja/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"
        }
    ]
}
```