スキーマの削除

Prev Next

VPC環境で利用できます。

トピックから2個以上のスキーマを一括削除します。

注意
  • スキーマを削除すると、そのスキーマを使用するメッセージのシリアル化および逆シリアル化に影響を与える可能性があります。
  • トピックを削除する場合、そのトピック配下のスキーマも削除されます。

リクエスト

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

メソッド URI
DELETE /api/v1/topics/{topicId}/schemas

リクエストヘッダ

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

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

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

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
schemas Array Required 削除対象のスキーマリスト
schemas[].type String Required スキーマタイプ
  • KEY | VALUE
schemas[].schemaId Integer Required スキーマ ID

リクエスト例

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

curl --location --request DELETE 'https://datastream.apigw.ntruss.com/api/v1/topics/mgNWA*****/schemas' \
--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 '{
  "schemas": [
    {
      "type": "KEY",
      "schemaId": 100
    },
    {
      "type": "VALUE", 
      "schemaId": 300
    }
  ]
}'

レスポンス

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

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

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

レスポンス例

スキーマが正常に削除された場合、レスポンスボディはなく、ステータスコード200を返します。

HTTP/1.1 200 OK