---
title: "listInstances"
slug: "pub-clouddb-serverless-v1-instance-listinstances"
updated: 2026-10-13T10:08:28Z
published: 2026-10-13T10:08:28Z
canonical: "api.ncloud-docs.com/pub-clouddb-serverless-v1-instance-listinstances"
---

> ## 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.

# listInstances

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

Ncloud 표준 표현을 적용한 API입니다.

클러스터의 인스턴스 목록을 조회합니다.

## 요청

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

| 메서드 | URI |
| --- | --- |
| GET | /mysql/v1/clusters/{clusterName}/instances |

### 요청 헤더

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

### 요청 경로 파라미터

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `clusterName` | String | Required | 클러스터 이름 - [listClusters](/docs/pub-clouddb-serverless-v1-cluster-listclusters) 참조 |

### 요청 쿼리 파라미터

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `pageNo` | Integer | Optional | 페이지 번호 - `0`~N (기본값: `0`) |
| `pageSize` | Integer | Optional | 페이지 크기 - `1`~`100` (기본값: `20`) |
| `sort` | Array | Optional | 정렬 기준 - 정렬 대상과 정렬 순서를 쉼표로 구분하여 입력 - 정렬 대상 - `name` \| `role` \| `zoneCode` \| `createdDateTime` - `name`: 인스턴스 이름 - `role`: 인스턴스 역할 - `zoneCode`: 인스턴스가 배치된 존 코드 - `createdDateTime`: 인스턴스 생성 일시 - 정렬 순서 - `asc` \| `desc` - `asc`: 오름차순 - `desc`: 내림차순 - 미입력 시 `role,asc` - 정렬 키 값이 같으면 `name` 순으로 정렬 - 여러 번 지정하면 다중 정렬 |

### 요청 예시

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

```
curl --location --request GET 'https://clouddb-serverless.apigw.ntruss.com/mysql/v1/clusters/test-cluster-01/instances?pageNo=0&pageSize=20&sort=name,asc' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## 응답

응답 형식을 설명합니다.

### 응답 바디

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `instances` | Array | - | 인스턴스 목록: [instances](/docs/pub-clouddb-serverless-v1-instance-listinstances#instances) |
| `pageNo` | Integer | - | 페이지 번호 - `0`~N |
| `pageSize` | Integer | - | 페이지 크기 - `1`~`100` |
| `totalElements` | Integer | - | 전체 항목 수 |
| `totalPages` | Integer | - | 전체 페이지 수 |

#### instances

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `name` | String | - | 인스턴스 이름 - `{clusterName}-{xxxxxxxx}` 형식 |
| `role` | String | - | 인스턴스 역할 - `PRIMARY` \| `REPLICA` - `PRIMARY`: 읽기 및 쓰기 - `REPLICA`: 읽기 전용 |
| `unit` | Number | - | 컴퓨팅 Unit |
| `memoryGb` | Integer | - | 할당 메모리 (GiB) |
| `storageType` | String | - | 데이터 스토리지 타입 - `CB2` - 현재 `CB2`만 제공 |
| `storageUsage` | Integer | - | 스토리지 사용량 (Byte) |
| `zoneCode` | String | - | 인스턴스가 배치된 존 코드 |
| `status` | String | - | 인스턴스 상태 - `CREATING` \| `RUNNING` \| `MODIFYING` \| `PAUSED` \| `DELETING` \| `FAILED` - `CREATING`: 생성 중인 상태 - `RUNNING`: 정상 기동되어 접속 가능한 상태 - `MODIFYING`: 설정 변경을 적용 중인 상태 - `PAUSED`: 일시 정지된 상태 - `DELETING`: 삭제 중인 상태 - `FAILED`: 오류로 중단된 상태 |
| `createdDateTime` | String | - | 인스턴스 생성 일시 - ISO 8601 형식 (UTC) |
| `startDateTime` | String | - | 인스턴스 기동 일시 - ISO 8601 형식 (UTC) |

### 응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
| --- | --- | --- | --- |
| 200 | - | - | 인스턴스 목록 |
| 400 | `InvalidParameter` | `The specified parameter is invalid.` | 파라미터 값이 허용 범위나 형식을 벗어난 경우 |

              참고

              

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

### 응답 예시

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

```
{
  "instances": [
    {
      "name": "test-cluster-01-a1b2c3d4",
      "role": "PRIMARY",
      "unit": 1,
      "memoryGb": 2,
      "storageType": "CB2",
      "storageUsage": 2779262976,
      "zoneCode": "KR-1",
      "status": "RUNNING",
      "createdDateTime": "2026-10-13T09:45:00Z",
      "startDateTime": "2026-10-13T09:50:00Z"
    },
    {
      "name": "test-cluster-01-e5f6a7b8",
      "role": "REPLICA",
      "unit": 1,
      "memoryGb": 2,
      "storageType": "CB2",
      "storageUsage": 2782363648,
      "zoneCode": "KR-1",
      "status": "RUNNING",
      "createdDateTime": "2026-10-13T09:45:00Z",
      "startDateTime": "2026-10-13T10:00:00Z"
    }
  ],
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 2,
  "totalPages": 1
}
```