スキーマレジストリ設定の照会

VPC環境で利用できます。

トピックのスキーマレジストリ互換性設定状態を照会します。

参考

スキーマの互換性設定とスキーマの存在有無を確認できます。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`topicId`	String	Required	トピック ID トピックリストの照会を参照

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`compatibility`	Object	-	スキーマ互換性情報
`compatibility.compatibilityLevel`	Boolean	-	スキーマ互換性の有効化・無効化 `true`: 互換性検査を有効化 (BACKWARD) `false`: 互換性検査を無効化 (NONE)
`compatibility.isSchemaExist`	Boolean	-	スキーマは存在するか

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

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

レスポンス例

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

{
    "compatibility": {
        "compatibilityLevel": true,
        "isSchemaExist": true
    }
}