Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 <yuezhang@freewheel.tv>
This commit is contained in:
zhangyue19921010 2021-04-10 09:20:47 +08:00 committed by GitHub
parent d939420f23
commit 95b82dd325
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/operations/api-reference.md
View File

@ -169,19 +169,37 @@ If no used segments are found for the given inputs, this API returns `204 No Con
##### GET ##### 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` * `/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` * `/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 Returns a list of the names of datasources, regardless of whether there are used segments belonging to those datasources in the cluster or not.
sources 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` * `/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 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.
sources as stored in the metadata store.
* `/druid/coordinator/v1/metadata/datasources/{dataSourceName}` * `/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}` * `/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, `{"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. the segments were marked as used) as the result of this API call.
* `/druid/coordinator/v1/datasources/{dataSourceName}/segments/{segmentId}` * `/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 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. result of this API call.
@ -326,7 +344,7 @@ JSON Request Payload:
* `/druid/coordinator/v1/datasources/{dataSourceName}` * `/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, `{"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. 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}` * `/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 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. result of this API call.