トピックリストの照会

Prev Next

VPC環境で利用できます。

トピックリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/topics

リクエストヘッダ

Data Stream APIで共通して使用されるヘッダの詳細は、Data Streamのリクエストヘッダをご参照ください。

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
sortBy String Optional ソート基準 (デフォルト: createdDate)
  • 作成日時createdDate、トピック名topicName
descending Boolean Optional 結果値のソート基準で、降順かどうか (デフォルト: true)
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

listの説明は次の通りです。

フィールド タイプ 必須の有無 説明
topicId String - トピック ID
topicName String - トピック名
description String - トピックの説明
partitions Number - トピックパーティション数
retentionMs Number - トピックパーティションメッセージの保存期間(ミリ秒)
pinned Boolean - コンソールの Topic画面内の上部固定にするか
  • true | false
    • true: 固定
    • false: 固定しない(作成日時を基準に昇順でソート)
status String - トピックの状態
  • CREATING | CREATED
    • CREATING: トピック作成中
    • CREATED: トピック作成完了(有効化)
tcpEndpoint String - TCPエンドポイント
createdDate String - トピック作成日時
  • ISO 8601形式
  • YYYY-MM-DDThh:mm:ssZ

レスポンスステータスコード

Data Stream APIで共通して使用されるレスポンスステータスコードの詳細は、Data Streamのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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"
        }
    ]
}