スキーマレジストリ情報の照会

Prev Next

VPC環境で利用できます。

トピックのスキーマレジストリ情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
endpoint String - スキーマレジストリエンドポイントの URL
isModifiable Boolean - スキーマ設定は変更可能か
  • true | false
    • true: KEYまたは VALUEスキーマが1つでも登録されているため、互換性設定などのスキーマ設定を変更可能
    • false: 登録されたスキーマがないため、スキーマ設定を変更不可

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

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

レスポンス例

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

{
  "endpoint": "https://schema-registry-*****.datastream.naverncp.com",
  "isModifiable": true
}