gateway-service-definitions/src/main/resources/services/druid-coordinator/0.0.1/service.xml

<!--
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-->
<service role="DRUID-COORDINATOR" name="druid-coordinator" version="0.0.1">
    <metadata>
        <type>API</type>
        <context>/druid-coordinator</context>
        <shortDesc>Druid Coordinator API</shortDesc>
        <description>The Druid Coordinator process is primarily responsible for segment management and distribution. 
            More specifically, the Druid Coordinator process communicates to Historical processes to load or drop segments based on configurations. 
            The Druid Coordinator is responsible for loading new segments, dropping outdated segments, managing segment replication, and balancing segment load.</description>
        <samples>
            <sample>
                <description>Fetch the current leader coordinator of the cluster</description>
                <method>GET</method>
                <path>druid/coordinator/v1/leader</path>
            </sample>
             <sample>
                <description>Fetch the percentage of segments actually loaded in the cluster versus segments that should be loaded in the cluster</description>
                <method>GET</method>
                <path>druid/coordinator/v1/loadstatus</path>
            </sample>
            <sample>
                <description>Marks as unused all segments belonging to a data source. Returns a JSON object of the form {"numChangedSegments": &lt;number&gt;} 
                    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</description>
                <method>DELETE</method>
                <path>druid/coordinator/v1/datasources/{dataSourceName}</path>
            </sample>
            <sample>
                <description>You may check out Apache Druid Coordinator's REST API documentation here</description>
                <value>https://druid.apache.org/docs/latest/operations/api-reference.html#coordinator</value>
            </sample>
        </samples>
    </metadata>
    <routes>
    <route path="druid-coordinator/status">
      <rewrite apply="DRUID-COORDINATOR/druid-coordinator/inbound/status"/>
    </route>
    <route path="druid-coordinator/druid/coordinator/v1/{**}?{**}">
        <rewrite apply="DRUID-COORDINATOR/druid-coordinator/inbound/api"/>
    </route>
    <route path="druid-coordinator/druid/indexer/v1/{**}?{**}">
      <rewrite apply="DRUID-COORDINATOR/druid-coordinator/inbound/api-indexer"/>
    </route>
  </routes>
</service>