トピック名の接頭辞の照会

Prev Next

VPC環境で利用できます。

トピック名の接頭辞を照会します。トピック名の接頭辞はトピックの作成時にトピック名の前に自動的に付く接頭辞で、重複を防ぐためにアカウントごとに固有の値で作成されます。

リクエスト

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

メソッド URI
GET /api/v1/topic-prefix

リクエストヘッダ

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
prefix String - トピック名の接頭辞

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

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

レスポンス例

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

{
    "prefix": "h4j6l-"
}