スキーマリストの照会

VPC環境で利用できます。

トピックに登録されているスキーマリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`type`	String	Optional	スキーマ適用対象 `key` \| `value` 指定しない場合、すべてのタイプを照会
`schemaType`	String	Optional	スキーマタイプ `AVRO` \| `JSON` \| `PROTOBUF` 指定しない場合、すべてのスキーマタイプを照会
`page`	Number	Optional	ページ番号 (0からスタート、デフォルト: 0)
`size`	Number	Optional	ページサイズ (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://datastream.apigw.ntruss.com/api/v1/topics/mgNWA*****/schemas?type=value&schemaType=AVRO&page=0&size=10' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`schemas`	Array	-	スキーマリスト
`totalCount`	Number	-	スキーマの総数
`pageNo`	Number	-	現在のページ番号
`pageSize`	Number	-	ページサイズ

`schemas`

schemasの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`schemaId`	Number	-	スキーマ ID
`schemaType`	String	-	スキーマタイプ `AVRO` \| `JSON` \| `PROTOBUF`
`type`	String	-	スキーマ適用対象 `key` \| `value`
`version`	Number	-	スキーマのバージョン
`createdDate`	String	-	スキーマの作成日時 ISO 8601形式 `YYYY-MM-DDThh:mm:ssZ`

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

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

レスポンス例

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

{
  "schemas": [
    {
      "schemaId": 1,
      "schemaType": "AVRO",
      "type": "value",
      "version": 1,
      "createdDate": "2024-01-01T10:00:00Z"
    },
    {
      "schemaId": 2,
      "schemaType": "JSON",
      "type": "key",
      "version": 1,
      "createdDate": "2024-01-01T11:00:00Z"
    }
  ],
  "totalCount": 2,
  "pageNo": 0,
  "pageSize": 10
}