トピックの照会

Prev Next

VPC環境で利用できます。

トピックの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /api/v1/topics/{topicId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
topicId String Required トピック ID

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://datastream.apigw.ntruss.com/api/v1/topics/mgNWA*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
topicId String - トピック ID
topicName String - トピック名
description String - トピックの説明
partitions Number - トピックパーティション数
retentionMs Number - トピックパーティションメッセージの保存期間(ミリ秒)
status String - トピックの状態
  • CREATING|CREATED
    • CREATING: トピック作成中
    • CREATED: トピック作成完了(有効化)
tcpEndpoint String - TCPエンドポイント
createdDate String - トピック作成日時
  • ISO 8601形式
  • YYYY-MM-DDThh:mm:ssZ
updatedDate String - トピック更新日時
  • ISO 8601形式
  • YYYY-MM-DDThh:mm:ssZ

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

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

レスポンス例

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

{
    "topicId": "mgNWA*****",
    "topicName": "h4j6l-ds001",
    "description": "Data Stream Topic",
    "partitions": 3,
    "retentionMs": 86400000,
    "status": "CREATED",
    "tcpEndpoint": "cluster-1.datastream.naverncp.com:30010",
    "createdDate": "2025-05-22T10:25:19Z",
    "updatedDate": "2025-05-22T14:14:41Z"
}