This is an automated email from the ASF dual-hosted git repository.
suneet pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/druid.git
The following commit(s) were added to refs/heads/master by this push:
new 95b82dd Add missing API references for coordinator (#10967)
95b82dd is described below
commit 95b82dd325ee7f808f4fc4891c966a93fe4b06fb
Author: zhangyue19921010 <[email protected]>
AuthorDate: Sat Apr 10 09:20:47 2021 +0800
Add missing API references for coordinator (#10967)
* add miss API references for coordinator
* add miss API references for coordinator
* add miss API references for coordinator
Co-authored-by: yuezhang <[email protected]>
---
docs/operations/api-reference.md | 36 +++++++++++++++++++++++++++---------
1 file changed, 27 insertions(+), 9 deletions(-)
diff --git a/docs/operations/api-reference.md b/docs/operations/api-reference.md
index b357aff..266d8bb 100644
--- a/docs/operations/api-reference.md
+++ b/docs/operations/api-reference.md
@@ -169,19 +169,37 @@ If no used segments are found for the given inputs, this
API returns `204 No Con
##### GET
+* `/druid/coordinator/v1/metadata/segments`
+
+Returns a list of all segments for each datasource enabled in the cluster.
+
+*
`/druid/coordinator/v1/metadata/segments?datasources={dataSourceName1}&datasources={dataSourceName2}`
+
+Returns a list of all segments for one or more specific datasources enabled in
the cluster.
+
+* `/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus`
+
+Returns a list of all segments for each datasource with the full segment
metadata and an extra field `overshadowed`.
+
+*
`/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus&datasources={dataSourceName1}&datasources={dataSourceName2}`
+
+Returns a list of all segments for one or more specific datasources with the
full segment metadata and an extra field `overshadowed`.
+
* `/druid/coordinator/v1/metadata/datasources`
-Returns a list of the names of data sources with at least one used segment in
the cluster.
+Returns a list of the names of datasources with at least one used segment in
the cluster.
* `/druid/coordinator/v1/metadata/datasources?includeUnused`
-Returns a list of the names of data sources, regardless of whether there are
used segments belonging to those data
-sources in the cluster or not.
+Returns a list of the names of datasources, regardless of whether there are
used segments belonging to those datasources in the cluster or not.
+
+* `/druid/coordinator/v1/metadata/datasources?includeDisabled`
+
+Returns a list of the names of datasources, regardless of whether the
datasource is disabled or not.
* `/druid/coordinator/v1/metadata/datasources?full`
-Returns a list of all data sources with at least one used segment in the
cluster. Returns all metadata about those data
-sources as stored in the metadata store.
+Returns a list of all datasources with at least one used segment in the
cluster. Returns all metadata about those datasources as stored in the metadata
store.
* `/druid/coordinator/v1/metadata/datasources/{dataSourceName}`
@@ -292,13 +310,13 @@ Caution : Avoid using indexing or kill tasks and these
API's at the same time fo
* `/druid/coordinator/v1/datasources/{dataSourceName}`
-Marks as used all segments belonging to a data source. Returns a JSON object
of the form
+Marks as used all segments belonging to a datasource. Returns a JSON object of
the form
`{"numChangedSegments": <number>}` with the number of segments in the database
whose state has been changed (that is,
the segments were marked as used) as the result of this API call.
* `/druid/coordinator/v1/datasources/{dataSourceName}/segments/{segmentId}`
-Marks as used a segment of a data source. Returns a JSON object of the form
`{"segmentStateChanged": <boolean>}` with
+Marks as used a segment of a datasource. Returns a JSON object of the form
`{"segmentStateChanged": <boolean>}` with
the boolean indicating if the state of the segment has been changed (that is,
the segment was marked as used) as the
result of this API call.
@@ -326,7 +344,7 @@ JSON Request Payload:
* `/druid/coordinator/v1/datasources/{dataSourceName}`
-Marks as unused all segments belonging to a data source. Returns a JSON object
of the form
+Marks as unused all segments belonging to a datasource. Returns a JSON object
of the form
`{"numChangedSegments": <number>}` with the number of segments in the database
whose state has been changed (that is,
the segments were marked as unused) as the result of this API call.
@@ -337,7 +355,7 @@ Runs a [Kill task](../ingestion/tasks.md) for a given
interval and datasource.
* `/druid/coordinator/v1/datasources/{dataSourceName}/segments/{segmentId}`
-Marks as unused a segment of a data source. Returns a JSON object of the form
`{"segmentStateChanged": <boolean>}` with
+Marks as unused a segment of a datasource. Returns a JSON object of the form
`{"segmentStateChanged": <boolean>}` with
the boolean indicating if the state of the segment has been changed (that is,
the segment was marked as unused) as the
result of this API call.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
