スキーマレジストリ設定の変更

Prev Next

VPC環境で利用できます。

スキーマの互換性設定を更新します。

参考

KEYと VALUEスキーマごとに互換性ポリシーを設定できます。互換性が有効化すると、新しいスキーマの登録時に既存のスキーマとの互換性検査が実行されます。

リクエスト

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

メソッド URI
PUT /api/v1/topics/{topicId}/registry-config

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
keyCompatibility Boolean Required KEYスキーマ互換性の有効化・無効化
  • true: 互換性検査を有効化 (BACKWARD)
  • false: 互換性検査を無効化 (NONE)
valueCompatibility Boolean Required VALUEスキーマ互換性の有効化・無効化
  • true: 互換性検査を有効化 (BACKWARD)
  • false: 互換性検査を無効化 (NONE)

リクエスト例

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

curl --location --request PUT 'https://datastream.apigw.ntruss.com/api/v1/topics/mgNWA*****/registry-config' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "keyCompatibility": true,
  "valueCompatibility": false
}'

レスポンス

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

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

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

レスポンス例

互換性設定が正常に更新された場合、レスポンスボディはなく、ステータスコード200を返します。

HTTP/1.1 200 OK