blob: b92416751cabc1a90ae3b85e02bbd91d7d353656 [file] [log] [blame]
"use strict";(self.webpackChunkdoris_website=self.webpackChunkdoris_website||[]).push([[10331],{15680:(e,n,t)=>{t.d(n,{xA:()=>c,yg:()=>g});var r=t(296540);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?i(Object(t),!0).forEach((function(n){a(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function p(e,n){if(null==e)return{};var t,r,a=function(e,n){if(null==e)return{};var t,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)t=i[r],n.indexOf(t)>=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)t=i[r],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var s=r.createContext({}),l=function(e){var n=r.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},c=function(e){var n=l(e.components);return r.createElement(s.Provider,{value:n},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},y=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),u=l(t),y=a,g=u["".concat(s,".").concat(y)]||u[y]||m[y]||i;return t?r.createElement(g,o(o({ref:n},c),{},{components:t})):r.createElement(g,o({ref:n},c))}));function g(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=y;var p={};for(var s in n)hasOwnProperty.call(n,s)&&(p[s]=n[s]);p.originalType=e,p[u]="string"==typeof e?e:a,o[1]=p;for(var l=2;l<i;l++)o[l]=t[l];return r.createElement.apply(null,o)}return r.createElement.apply(null,t)}y.displayName="MDXCreateElement"},739486:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>l});var r=t(58168),a=(t(296540),t(15680));const i={title:"Set Config Action",language:"zh-CN"},o=void 0,p={unversionedId:"admin-manual/fe/set-config-action",id:"admin-manual/fe/set-config-action",title:"Set Config Action",description:"\x3c!--",source:"@site/i18n/zh-CN/docusaurus-plugin-content-docs/current/admin-manual/fe/set-config-action.md",sourceDirName:"admin-manual/fe",slug:"/admin-manual/fe/set-config-action",permalink:"/zh-CN/docs/dev/admin-manual/fe/set-config-action",draft:!1,tags:[],version:"current",frontMatter:{title:"Set Config Action",language:"zh-CN"},sidebar:"docs",previous:{title:"Row Count Action",permalink:"/zh-CN/docs/dev/admin-manual/fe/row-count-action"},next:{title:"Show Data Action",permalink:"/zh-CN/docs/dev/admin-manual/fe/show-data-action"}},s={},l=[{value:"Request",id:"request",level:2},{value:"Description",id:"description",level:2},{value:"Path parameters",id:"path-parameters",level:2},{value:"Query parameters",id:"query-parameters",level:2},{value:"Request body",id:"request-body",level:2},{value:"Response",id:"response",level:2},{value:"Examples",id:"examples",level:2}],c={toc:l},u="wrapper";function m(e){let{components:n,...t}=e;return(0,a.yg)(u,(0,r.A)({},c,t,{components:n,mdxType:"MDXLayout"}),(0,a.yg)("h2",{id:"request"},"Request"),(0,a.yg)("p",null,(0,a.yg)("inlineCode",{parentName:"p"},"GET /api/_set_config")),(0,a.yg)("h2",{id:"description"},"Description"),(0,a.yg)("p",null,"\u7528\u4e8e\u52a8\u6001\u8bbe\u7f6e FE \u7684\u53c2\u6570\u3002\u8be5\u547d\u4ee4\u7b49\u540c\u4e8e\u901a\u8fc7 ",(0,a.yg)("inlineCode",{parentName:"p"},"ADMIN SET FRONTEND CONFIG")," \u547d\u4ee4\u3002\u4f46\u8be5\u547d\u4ee4\u4ec5\u4f1a\u8bbe\u7f6e\u5bf9\u5e94 FE \u8282\u70b9\u7684\u914d\u7f6e\u3002\u5e76\u4e14\u4e0d\u4f1a\u81ea\u52a8\u8f6c\u53d1 ",(0,a.yg)("inlineCode",{parentName:"p"},"MasterOnly")," \u914d\u7f6e\u9879\u7ed9 Master FE \u8282\u70b9\u3002"),(0,a.yg)("h2",{id:"path-parameters"},"Path parameters"),(0,a.yg)("p",null,"\u65e0"),(0,a.yg)("h2",{id:"query-parameters"},"Query parameters"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("p",{parentName:"li"},(0,a.yg)("inlineCode",{parentName:"p"},"confkey1=confvalue1")),(0,a.yg)("p",{parentName:"li"}," \u6307\u5b9a\u8981\u8bbe\u7f6e\u7684\u914d\u7f6e\u540d\u79f0\uff0c\u5176\u503c\u4e3a\u8981\u4fee\u6539\u7684\u914d\u7f6e\u503c\u3002\n")),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("p",{parentName:"li"},(0,a.yg)("inlineCode",{parentName:"p"},"persist")),(0,a.yg)("p",{parentName:"li"}," \u662f\u5426\u8981\u5c06\u4fee\u6539\u7684\u914d\u7f6e\u6301\u4e45\u5316\u3002\u9ed8\u8ba4\u4e3a false\uff0c\u5373\u4e0d\u6301\u4e45\u5316\u3002\u5982\u679c\u4e3a true\uff0c\u8fd9\u4fee\u6539\u540e\u7684\u914d\u7f6e\u9879\u4f1a\u5199\u5165 ",(0,a.yg)("inlineCode",{parentName:"p"},"fe_custom.conf")," \u6587\u4ef6\u4e2d\uff0c\u5e76\u5728 FE \u91cd\u542f\u540e\u4ecd\u4f1a\u751f\u6548\u3002")),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("p",{parentName:"li"},(0,a.yg)("inlineCode",{parentName:"p"},"reset_persist")),(0,a.yg)("p",{parentName:"li"}," \u662f\u5426\u8981\u6e05\u7a7a\u539f\u6765\u7684\u6301\u4e45\u5316\u914d\u7f6e\uff0c\u53ea\u5728 persist \u53c2\u6570\u4e3a true \u65f6\u751f\u6548\u3002\u4e3a\u4e86\u517c\u5bb9\u539f\u6765\u7684\u7248\u672c\uff0creset_persist \u9ed8\u8ba4\u4e3a true\u3002",(0,a.yg)("br",{parentName:"p"}),"\n","\u5982\u679c persist \u8bbe\u4e3a true\uff0c\u4e0d\u8bbe\u7f6e reset_persist \u6216 reset_persist \u4e3a true\uff0c\u5c06\u5148\u6e05\u7a7a",(0,a.yg)("inlineCode",{parentName:"p"},"fe_custom.conf"),"\u6587\u4ef6\u4e2d\u7684\u914d\u7f6e\u518d\u5c06\u672c\u6b21\u4fee\u6539\u7684\u914d\u7f6e\u5199\u5165",(0,a.yg)("inlineCode",{parentName:"p"},"fe_custom.conf"),"\uff1b",(0,a.yg)("br",{parentName:"p"}),"\n","\u5982\u679c persist \u8bbe\u4e3a true\uff0creset_persist \u4e3a false\uff0c\u672c\u6b21\u4fee\u6539\u7684\u914d\u7f6e\u9879\u5c06\u4f1a\u589e\u91cf\u6dfb\u52a0\u5230",(0,a.yg)("inlineCode",{parentName:"p"},"fe_custom.conf"),"\u3002"))),(0,a.yg)("h2",{id:"request-body"},"Request body"),(0,a.yg)("p",null,"\u65e0"),(0,a.yg)("h2",{id:"response"},"Response"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},'{\n "msg": "success",\n "code": 0,\n "data": {\n "set": {\n "key": "value"\n },\n "err": [\n {\n "config_name": "",\n "config_value": "",\n "err_info": ""\n }\n ],\n "persist":""\n },\n "count": 0\n}\n')),(0,a.yg)("p",null,(0,a.yg)("inlineCode",{parentName:"p"},"set")," \u5b57\u6bb5\u8868\u793a\u8bbe\u7f6e\u6210\u529f\u7684\u914d\u7f6e\u3002",(0,a.yg)("inlineCode",{parentName:"p"},"err")," \u5b57\u6bb5\u8868\u793a\u8bbe\u7f6e\u5931\u8d25\u7684\u914d\u7f6e\u3002 ",(0,a.yg)("inlineCode",{parentName:"p"},"persist")," \u5b57\u6bb5\u8868\u793a\u6301\u4e45\u5316\u4fe1\u606f\u3002"),(0,a.yg)("h2",{id:"examples"},"Examples"),(0,a.yg)("ol",null,(0,a.yg)("li",{parentName:"ol"},(0,a.yg)("p",{parentName:"li"},"\u8bbe\u7f6e ",(0,a.yg)("inlineCode",{parentName:"p"},"storage_min_left_capacity_bytes")," \u3001 ",(0,a.yg)("inlineCode",{parentName:"p"},"replica_ack_policy")," \u548c ",(0,a.yg)("inlineCode",{parentName:"p"},"agent_task_resend_wait_time_ms")," \u4e09\u4e2a\u914d\u7f6e\u7684\u503c\u3002"),(0,a.yg)("pre",{parentName:"li"},(0,a.yg)("code",{parentName:"pre"},'GET /api/_set_config?storage_min_left_capacity_bytes=1024&replica_ack_policy=SIMPLE_MAJORITY&agent_task_resend_wait_time_ms=true\n\nResponse:\n{\n"msg": "success",\n"code": 0,\n"data": {\n "set": {\n "storage_min_left_capacity_bytes": "1024"\n },\n "err": [\n {\n "config_name": "replica_ack_policy",\n "config_value": "SIMPLE_MAJORITY",\n "err_info": "Not support dynamic modification."\n },\n {\n "config_name": "agent_task_resend_wait_time_ms",\n "config_value": "true",\n "err_info": "Unsupported configuration value type."\n }\n ],\n "persist": ""\n},\n"count": 0\n}\n\nstorage_min_left_capacity_bytes \u8bbe\u7f6e\u6210\u529f\uff1b \nreplica_ack_policy \u8bbe\u7f6e\u5931\u8d25\uff0c\u539f\u56e0\u662f\u8be5\u914d\u7f6e\u9879\u4e0d\u652f\u6301\u52a8\u6001\u4fee\u6539\uff1b \nagent_task_resend_wait_time_ms \u8bbe\u7f6e\u5931\u8d25\uff0c\u56e0\u4e3a\u8be5\u914d\u7f6e\u9879\u7c7b\u578b\u4e3a long\uff0c\u8bbe\u7f6e boolean \u7c7b\u578b\u5931\u8d25\u3002\n'))),(0,a.yg)("li",{parentName:"ol"},(0,a.yg)("p",{parentName:"li"},"\u8bbe\u7f6e ",(0,a.yg)("inlineCode",{parentName:"p"},"max_bytes_per_broker_scanner")," \u5e76\u6301\u4e45\u5316"),(0,a.yg)("pre",{parentName:"li"},(0,a.yg)("code",{parentName:"pre"},'GET /api/_set_config?max_bytes_per_broker_scanner=21474836480&persist=true&reset_persist=false\n\nResponse:\n{\n"msg": "success",\n"code": 0,\n"data": {\n "set": {\n "max_bytes_per_broker_scanner": "21474836480"\n },\n "err": [],\n "persist": "ok"\n},\n"count": 0\n}\n')),(0,a.yg)("p",{parentName:"li"},"fe/conf \u76ee\u5f55\u751f\u6210 fe_custom.conf\uff1a"),(0,a.yg)("pre",{parentName:"li"},(0,a.yg)("code",{parentName:"pre"},"#THIS IS AN AUTO GENERATED CONFIG FILE.\n#You can modify this file manually, and the configurations in this file\n#will overwrite the configurations in fe.conf\n#Wed Jul 28 12:43:14 CST 2021\nmax_bytes_per_broker_scanner=21474836480\n")))))}m.isMDXComponent=!0}}]);