| "use strict";(self.webpackChunk=self.webpackChunk||[]).push([[1718],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>f});var n=r(67294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},i=Object.keys(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var u=n.createContext({}),p=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(u.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,u=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,f=d["".concat(u,".").concat(m)]||d[m]||c[m]||i;return r?n.createElement(f,l(l({ref:t},s),{},{components:r})):n.createElement(f,l({ref:t},s))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var u in t)hasOwnProperty.call(t,u)&&(o[u]=t[u]);o.originalType=e,o[d]="string"==typeof e?e:a,l[1]=o;for(var p=2;p<i;p++)l[p]=r[p];return n.createElement.apply(null,l)}return n.createElement.apply(null,r)}m.displayName="MDXCreateElement"},7592:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>u,default:()=>f,frontMatter:()=>o,metadata:()=>p,toc:()=>d});var n=r(87462),a=r(63366),i=(r(67294),r(3905)),l=["components"],o={id:"retention-rules-api",title:"Retention rules API",sidebar_label:"Retention rules"},u=void 0,p={unversionedId:"api-reference/retention-rules-api",id:"api-reference/retention-rules-api",title:"Retention rules API",description:"\x3c!--",source:"@site/docs/latest/api-reference/retention-rules-api.md",sourceDirName:"api-reference",slug:"/api-reference/retention-rules-api",permalink:"/docs/latest/api-reference/retention-rules-api",draft:!1,tags:[],version:"current",frontMatter:{id:"retention-rules-api",title:"Retention rules API",sidebar_label:"Retention rules"},sidebar:"docs",previous:{title:"Supervisors",permalink:"/docs/latest/api-reference/supervisor-api"},next:{title:"Data management",permalink:"/docs/latest/api-reference/data-management-api"}},s={},d=[{value:"Retention rules",id:"retention-rules",level:2}],c={toc:d},m="wrapper";function f(e){var t=e.components,r=(0,a.Z)(e,l);return(0,i.kt)(m,(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"This document describes the API endpoints for managing retention rules in Apache Druid."),(0,i.kt)("h2",{id:"retention-rules"},"Retention rules"),(0,i.kt)("p",null,"Note that all ",(0,i.kt)("em",{parentName:"p"},"interval")," URL parameters are ISO 8601 strings delimited by a ",(0,i.kt)("inlineCode",{parentName:"p"},"_")," instead of a ",(0,i.kt)("inlineCode",{parentName:"p"},"/")," as in ",(0,i.kt)("inlineCode",{parentName:"p"},"2016-06-27_2016-06-28"),"."),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"GET /druid/coordinator/v1/rules")),(0,i.kt)("p",null,"Returns all rules as JSON objects for all datasources in the cluster including the default datasource."),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"GET /druid/coordinator/v1/rules/{dataSourceName}")),(0,i.kt)("p",null,"Returns all rules for a specified datasource."),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"GET /druid/coordinator/v1/rules/{dataSourceName}?full")),(0,i.kt)("p",null,"Returns all rules for a specified datasource and includes default datasource."),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"GET /druid/coordinator/v1/rules/history?interval=<interval>")),(0,i.kt)("p",null,"Returns audit history of rules for all datasources. Default value of interval can be specified by setting ",(0,i.kt)("inlineCode",{parentName:"p"},"druid.audit.manager.auditHistoryMillis")," (1 week if not configured) in Coordinator ",(0,i.kt)("inlineCode",{parentName:"p"},"runtime.properties"),"."),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"GET /druid/coordinator/v1/rules/history?count=<n>")),(0,i.kt)("p",null,"Returns last ",(0,i.kt)("inlineCode",{parentName:"p"},"n")," entries of audit history of rules for all datasources."),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"GET /druid/coordinator/v1/rules/{dataSourceName}/history?interval=<interval>")),(0,i.kt)("p",null,"Returns audit history of rules for a specified datasource. Default value of interval can be specified by setting ",(0,i.kt)("inlineCode",{parentName:"p"},"druid.audit.manager.auditHistoryMillis")," (1 week if not configured) in Coordinator ",(0,i.kt)("inlineCode",{parentName:"p"},"runtime.properties"),"."),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"GET /druid/coordinator/v1/rules/{dataSourceName}/history?count=<n>")),(0,i.kt)("p",null,"Returns last ",(0,i.kt)("inlineCode",{parentName:"p"},"n")," entries of audit history of rules for a specified datasource."),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"POST /druid/coordinator/v1/rules/{dataSourceName}")),(0,i.kt)("p",null,"POST with a list of rules in JSON form to update rules."),(0,i.kt)("p",null,"Optional Header Parameters for auditing the config change can also be specified."),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:null},"Header Param Name"),(0,i.kt)("th",{parentName:"tr",align:null},"Description"),(0,i.kt)("th",{parentName:"tr",align:null},"Default"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"X-Druid-Author")),(0,i.kt)("td",{parentName:"tr",align:null},"Author making the config change"),(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},'""'))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"X-Druid-Comment")),(0,i.kt)("td",{parentName:"tr",align:null},"Comment describing the change being done"),(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},'""'))))))}f.isMDXComponent=!0}}]); |