---
title: "토픽 목록 조회"
slug: "datastream-gettopic"
tags: ["토픽", "Topic", "Data Stream", "VPC"]
updated: 2026-09-17T09:16:12Z
published: 2026-09-17T09:16:12Z
canonical: "api.ncloud-docs.com/datastream-gettopic"
---

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

# 토픽 목록 조회

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

토픽 목록을 조회합니다.

## 요청

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

| 메서드 | URI |
| --- | --- |
| GET | /api/v1/topics |

### 요청 헤더

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

### 요청 쿼리 파라미터

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `sortBy` | String | Optional | 정렬 기준 - `createdDate` (기본값) \| `topicName` - `createdDate`: 생성 일시 - `topicName`: 토픽 이름 |
| `descending` | Boolean | Optional | 결과 값 정렬 기준으로 내림차순 여부 - `true` (기본값) \| `false` - `true`: 내림차순 - `false`: 오름차순 |
| `searchText` | String | Optional | 검색 문자열 - 토픽 이름, 토픽 설명으로 검색 |

### 요청 예시

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

```
curl --location --request GET 'https://datastream.apigw.ntruss.com/api/v1/topics?sortBy=createdDate&descending=true' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
```

## 응답

응답 형식을 설명합니다.

### 응답 바디

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `list` | Array | - | 토픽 목록: [list](/docs/datastream-gettopic#list) |

#### `list`

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `topicId` | String | - | 토픽 아이디 |
| `topicName` | String | - | 토픽 이름 |
| `description` | String | - | 토픽 설명 |
| `partitions` | Number | - | 토픽 파티션 수 |
| `retentionMs` | Number | - | 토픽 파티션 메시지 보존 기간(밀리초) |
| `pinned` | Boolean | - | 콘솔의 Topic 화면 내 상단 고정 여부 - `true` \| `false` - `true`: 고정 - `false`: 고정 안 함(생성 일시 기준 오름차순 정렬) |
| `status` | String | - | 토픽 상태 - `CREATING` \| `CREATED` \| `PENDING_DELETION` \| `DELETE_ERROR` \| `DELETED` \| `UNKNOWN` - `CREATING`: 토픽 생성 중 - `CREATED`: 토픽 생성 완료(활성) - `PENDING_DELETION`: 삭제 대기 중 - `DELETE_ERROR`: 삭제 오류 - `DELETED`: 삭제 완료 - `UNKNOWN`: 알 수 없음 |
| `tcpEndpoint` | String | - | TCP 엔드포인트 |
| `createdDate` | String | - | 토픽 생성 일시 - ISO 8601 형식 - `YYYY-MM-DDThh:mm:ssZ` |

### 응답 상태 코드

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

### 응답 예시

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

```
{
    "list": [
        {
            "topicId": "52qLj*****",
            "topicName": "h4j6l-ds002",
            "description": "Data Stream Topic",
            "partitions": 1,
            "retentionMs": 86400000,
            "pinned": false,
            "status": "CREATED",
            "tcpEndpoint": "sample-cluster.datastream.naverncp.com:{PORT}",
            "createdDate": "2025-06-05T20:21:29Z"
        },
        {
            "topicId": "wgif3*****",
            "topicName": "h4j6l-ds001",
            "description": "Data Stream Topic",
            "partitions": 2,
            "retentionMs": 86400000,
            "pinned": true,
            "status": "CREATED",
            "tcpEndpoint": "sample-cluster.datastream.naverncp.com:{PORT}",
            "createdDate": "2025-06-04T15:04:49Z"
        }
    ]
}
```