스키마 목록 조회

VPC 환경에서 이용 가능합니다.

토픽에 등록된 스키마 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/api/v1/topics/{topicId}/schemas

요청 헤더

Data Stream API에서 공통으로 사용하는 헤더에 대한 정보는 Data Stream 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`topicId`	String	Required	토픽 아이디 토픽 목록 조회 참조

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`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	-	스키마 아이디
`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
}