데이터 스트림 정보 API

데이터 스트림 정보 API (Get Data Stream API)

생성한 데이터 스트림이 어떤 상태인지 확인하고 싶으시죠? 데이터 스트림 정보 API가 하나 이상의 데이터 스트림에 대한 정보를 반환해요. 백킹 인덱스(backing indexes), 세대(generation), 상태(status)가 포함돼요.

출처: 문서

본문

1.0에서 도입

데이터 스트림 정보 API는 백킹 인덱스, 세대, 상태를 포함해 하나 이상의 데이터 스트림에 대한 정보를 반환해요.

엔드포인트

GET /_data_stream
GET /_data_stream/{name}

경로 파라미터

다음 표는 사용 가능한 경로 파라미터예요. 모든 경로 파라미터는 선택적이에요.

Parameter	Data type	Description
name	List or String	요청을 제한하는 데 사용되는 데이터 스트림 이름의 쉼표로 구분된 목록이에요. 와일드카드(*) 표현식을 지원해요. 생략하면 모든 데이터 스트림이 반환돼요.

쿼리 파라미터

다음 표는 사용 가능한 쿼리 파라미터예요. 모든 쿼리 파라미터는 선택적이에요.

Parameter	Data type	Description	Default
error_trace	Boolean	반환된 오류의 스택 트레이스를 포함할지 여부예요.	false
filter_path	List or String	응답을 줄이는 데 사용돼요. 이 파라미터는 쉼표로 구분된 필터 목록을 받아요. 와일드카드로 필드나 필드 이름의 일부를 매칭할 수 있어요. `-`로 필드를 제외할 수도 있어요.	N/A
human	Boolean	통계에 대해 사람이 읽을 수 있는 값을 반환할지 여부예요.	false
pretty	Boolean	반환된 JSON 응답을 pretty 형식으로 할지 여부예요.	false
source	String	URL 인코딩된 요청 정의예요. POST가 아닌 요청에 요청 본문을 받아들이지 않는 라이브러리에 유용해요.	N/A

예시 요청

다음 예시 요청은 클러스터의 모든 데이터 스트림에 대한 정보를 반환해요.

GET /_data_stream

특정 데이터 스트림에 대한 정보를 반환하려면 이름을 name 경로 파라미터로 제공해요.

GET /_data_stream/logs-app

예시 응답

{
  "data_streams": [
    {
      "name": "logs-app",
      "timestamp_field": {
        "name": "@timestamp"
      },
      "indices": [
        {
          "index_name": ".ds-logs-app-000001",
          "index_uuid": "23dD0HE5Sg2kSLLAP_YtNA"
        }
      ],
      "generation": 1,
      "status": "YELLOW",
      "template": "template-logs-app"
    }
  ]
}

응답 본문 필드

Field	Data type	Description
data_streams	Array	각 데이터 스트림에 대해 하나씩인 객체 목록이에요. 객체 필드는 The data stream objects를 참고하세요.

데이터 스트림 객체 (The data stream objects)

각 데이터 스트림 객체는 다음 필드를 포함해요.

Field	Data type	Description
name	String	데이터 스트림의 이름이에요.
timestamp_field	Object	데이터 스트림의 타임스탬프 필드 구성이에요.
timestamp_field.name	String	타임스탬프 필드의 이름으로, 보통 @timestamp예요.
indices	Array	데이터 스트림의 백킹 인덱스 목록이에요. 배열의 마지막 항목이 현재 쓰기 인덱스예요. 객체 필드는 The backing index objects를 참고하세요.
generation	Integer	데이터 스트림의 현재 세대예요. 이 숫자는 롤오버할 때마다 1씩 증가해요.
status	String	백킹 인덱스의 상태에 기반한 데이터 스트림의 상태예요. 유효한 값은 GREEN, YELLOW, RED예요.
template	String	데이터 스트림을 만드는 데 사용된 인덱스 템플릿의 이름이에요.
hidden	Boolean	데이터 스트림이 숨겨졌는지 여부예요.
system	Boolean	데이터 스트림이 OpenSearch에 의해 내부적으로 관리되며 일반 사용자 상호작용으로 수정할 수 없는지 여부예요.
ilm_policy	String	구성된 경우 관련 Index State Management(ISM) 정책의 이름이에요.
allow_custom_routing	Boolean	데이터 스트림이 쓰기 요청에 사용자 정의 라우팅을 허용하는지 여부예요.
_meta	Object	데이터 스트림에 첨부된 사용자 정의 메타데이터예요.

백킹 인덱스 객체 (The backing index objects)

각 백킹 인덱스 객체는 다음 필드를 포함해요.

Field	Data type	Description
index_name	String	백킹 인덱스의 이름이에요.
index_uuid	String	백킹 인덱스의 UUID예요.

보안

Security 플러그인을 사용한다면 적절한 권한이 있는지 확인해야 해요: indices:admin/data_stream/get.

더 알아보기 (Learn more)

indices 배열의 마지막 항목이 현재 쓰기 인덱스라는 점을 기억하면 데이터 흐름을 이해하기 쉬워요.
데이터 스트림에 대한 통계는 Get data stream stats에서 확인할 수 있어요.

데이터 스트림 정보 API