トピックの作成

Prev Next

VPC環境で利用できます。

トピックを作成します。

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
name String Required トピック名
  • 接頭辞-名前形式で入力
  • 英字の小文字、数字、記号の「-」を組み合わせて、接頭辞を含めて200文字以内で入力
  • トピック名の接頭辞の照会を参照
  • <例> トピック名の接頭辞がh4j6l-で、設定する名前がds001の場合: h4j6l-ds001と入力
description String Optional トピックの説明 (最大200文字)
partitions Number Optional トピックパーティション数
  • 1~16 (デフォルト: 1)
retentionMs Number Optional トピックパーティションメッセージの保存期間(ミリ秒)
  • 3600000~1296000000 (デフォルト: 86400000)

リクエスト例

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

curl --location --request POST 'https://datastream.apigw.ntruss.com/api/v1/topics' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "name": "h4j6l-ds001",
    "description": "Data Stream Topic",
    "partitions": 1,
    "retentionMs": 86400000
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
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": "jkH8v*****",
    "topicName": "h4j6l-ds001",
    "description": "Data Stream Topic",
    "partitions": 1,
    "retentionMs": 86400000,
    "status": "CREATED",
    "tcpEndpoint": "sample-cluster.datastream.naverncp.com:{PORT}",
    "createdDate": "2025-05-28T17:29:21Z",
    "updatedDate": "2025-05-28T17:29:21Z"
}