[DOCS] Document get data stream API response body (#58344) (#58360)

This commit is contained in:
James Rodewig 2020-06-18 16:42:05 -04:00 committed by GitHub
parent b8fa90198b
commit d8dc638a67
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 0 deletions

View File

@ -60,6 +60,46 @@ GET /_data_stream/my-data-stream
Name of the data stream to retrieve.
Wildcard (`*`) expressions are supported.
[role="child_attributes"]
[[get-data-stream-api-response-body]]
==== {api-response-body-title}
`name`::
(string)
Name of the data stream.
`timestamp_field`::
(string)
Name of the data stream's timestamp field. This field must be included in every
document indexed to the data stream.
`indices`::
(array of objects)
Array of objects containing information about the data stream's backing
indices.
+
The last item in this array contains information about the stream's current
<<data-stream-write-index,write index>>.
+
.Properties of `indices` objects
[%collapsible%open]
====
`index_name`::
(string)
Name of the backing index. For naming conventions, see
<<data-streams-generation>>.
`index_uuid`::
(string)
Universally unique identifier (UUID) for the index.
====
`generation`::
(integer)
Current <<data-streams-generation,generation>> for the data stream. This number
acts as a cumulative count of the stream's backing indices, including
deleted indices.
[[get-data-stream-api-example]]
==== {api-examples-title}