| <!doctype html> |
| <html lang="en" dir="ltr"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="generator" content="Docusaurus v2.0.0-beta.4"> |
| <link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache ShenYu Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache ShenYu Blog Atom Feed"> |
| <link rel="search" type="application/opensearchdescription+xml" title="Apache ShenYu" href="/opensearch.xml"> |
| <link rel="alternate" type="application/rss+xml" href="/news/rss.xml" title="Apache ShenYu Blog RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/news/atom.xml" title="Apache ShenYu Blog Atom Feed"><title data-react-helmet="true">Local Model | Apache ShenYu</title><meta data-react-helmet="true" property="og:url" content="https://shenyu.apache.org//docs/2.4.2/developer/local-model"><meta data-react-helmet="true" name="docsearch:language" content="en"><meta data-react-helmet="true" name="docsearch:version" content="2.4.2"><meta data-react-helmet="true" name="docsearch:docusaurus_tag" content="docs-default-2.4.2"><meta data-react-helmet="true" property="og:title" content="Local Model | Apache ShenYu"><meta data-react-helmet="true" name="description" content="Local Model"><meta data-react-helmet="true" property="og:description" content="Local Model"><meta data-react-helmet="true" name="keywords" content="Local Model"><link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.svg"><link data-react-helmet="true" rel="canonical" href="https://shenyu.apache.org//docs/2.4.2/developer/local-model"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//docs/2.4.2/developer/local-model" hreflang="en"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//zh/docs/2.4.2/developer/local-model" hreflang="zh"><link data-react-helmet="true" rel="alternate" href="https://shenyu.apache.org//docs/2.4.2/developer/local-model" hreflang="x-default"><link data-react-helmet="true" rel="preconnect" href="https://BH4D9OD16A-dsn.algolia.net" crossorigin="anonymous"><link rel="stylesheet" href="/assets/css/styles.b6f9a199.css"> |
| <link rel="preload" href="/assets/js/runtime~main.490de106.js" as="script"> |
| <link rel="preload" href="/assets/js/main.cb386500.js" as="script"> |
| </head> |
| <body> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <div><a href="#" class="skipToContent_OuoZ">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><img src="/img/logo.svg" alt="Apache ShenYu Logo" class="themedImage_TMUO themedImage--light_4Vu1 navbar__logo"><img src="/img/logo-light.svg" alt="Apache ShenYu Logo" class="themedImage_TMUO themedImage--dark_uzRr navbar__logo"></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/download">Download</a><a class="navbar__item navbar__link" href="/document">Docs</a><a class="navbar__item navbar__link" href="/community/contributor-guide">Community</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/event">Event</a><a class="navbar__item navbar__link" href="/news">News</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/users">Users</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__item navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><a href="https://github.com/apache/shenyu" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link"><span>GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_wgqa"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></span></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" class="navbar__item navbar__link"><span><svg t="1631348384596" class="icon" viewBox="0 0 1024 1024" version="1.1" style="vertical-align:text-bottom;margin-right:5px" p-id="557" width="20" height="20"><path d="M547.797333 638.208l-104.405333-103.168 1.237333-1.28a720.170667 720.170667 0 0 0 152.490667-268.373333h120.448V183.082667h-287.744V100.906667H347.605333v82.218666H59.818667V265.386667h459.178666a648.234667 648.234667 0 0 1-130.304 219.946666 643.242667 643.242667 0 0 1-94.976-137.728H211.541333a722.048 722.048 0 0 0 122.453334 187.434667l-209.194667 206.378667 58.368 58.368 205.525333-205.525334 127.872 127.829334 31.232-83.84m231.424-208.426667h-82.218666l-184.96 493.312h82.218666l46.037334-123.306667h195.242666l46.464 123.306667h82.218667l-185.002667-493.312m-107.690666 287.744l66.56-178.005333 66.602666 178.005333z" fill="currentColor" p-id="558"></path></svg><span>English</span></span></a><ul class="dropdown__menu"><li><a href="/docs/2.4.2/developer/local-model" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" style="text-transform:capitalize">English</a></li><li><a href="/zh/docs/2.4.2/developer/local-model" target="_self" rel="noopener noreferrer" class="dropdown__link" style="text-transform:capitalize">简体中文</a></li></ul></div><div class="react-toggle toggle_2i4l react-toggle--disabled"><div class="react-toggle-track" role="button" tabindex="-1"><div class="react-toggle-track-check"><span class="toggle_iYfV">🌜</span></div><div class="react-toggle-track-x"><span class="toggle_iYfV">🌞</span></div><div class="react-toggle-thumb"></div></div><input type="checkbox" class="react-toggle-screenreader-only" aria-label="Switch between dark and light mode"></div><div class="searchBox_Bc3W"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper docs-wrapper doc-page"><div class="docPage_lDyR"><button class="clean-btn backToTopButton_i9tI" type="button" title="Scroll to top"><svg viewBox="0 0 24 24" width="28"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z" fill="currentColor"></path></svg></button><aside class="docSidebarContainer_0YBq"><div class="sidebar_a3j0"><nav class="menu thin-scrollbar menu_cyFh menuWithAnnouncementBar_+O1J"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/2.4.2/index">Overview</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Design</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Deployment</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Quick Start</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">User Guide</a></li><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#">Plugin Center</a></li><li class="menu__list-item"><a class="menu__link menu__link--sublist menu__link--active" href="#">Developer Documentation</a><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="menu__list-item menu__list-item--collapsed"><a class="menu__link menu__link--sublist" href="#" tabindex="0">SPI</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/custom-filter">Custom Filter</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/custom-parsing-ip-and-host">Fetching Correct IP Address And Host</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/custom-plugin">Custom Plugin</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/custom-result">Custom Response</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/custom-sign-algorithm">Custom Sign Algorithm</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/debug-agent">Debug and run agent module locally</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/developer-shenyu-client">A multilingual HTTP client</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/file-and-image">File Upload And Download</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/integration-test">Run Integration Test Locally</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link menu__link--active active" tabindex="0" href="/docs/2.4.2/developer/local-model">Local Model</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/shenyu-optimize">ShenYu Optimize</a></li><li class="menu__list-item"><a class="menu__link" tabindex="0" href="/docs/2.4.2/developer/thread-model">Thread Model</a></li></ul></li></ul></nav></div></aside><main class="docMainContainer_r8cw"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_zHA2"><div class="alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for Apache ShenYu <b>2.4.2</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/developer/local-model">latest version</a></b> (2.6.1).</div></div><div class="docItemContainer_oiyr"><article><span class="badge badge--secondary">Version: 2.4.2</span><div class="tocCollapsible_aw-L tocMobile_Tx6Y"><button type="button" class="clean-btn tocCollapsibleButton_zr6a">On this page</button></div><div class="markdown"><header><h1 class="h1Heading_dC7a">Local Model</h1></header><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="description"></a>Description<a class="hash-link" href="#description" title="Direct link to heading">#</a></h2><ul><li><p>Standalone environment, then use the local <code>API</code> to update the apache shenyu gateway data。</p></li><li><p>Common result:</p></li></ul><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">success</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><ul><li>Common preFix ： <code>localhost:9195/shenyu</code></li></ul><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="plugin"></a>Plugin<a class="hash-link" href="#plugin" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="saveorupdate"></a>saveOrUpdate<a class="hash-link" href="#saveorupdate" title="Direct link to heading">#</a></h3><p>save or update plugin data</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method"></a>Request Method<a class="hash-link" href="#request-method" title="Direct link to heading">#</a></h5><p>POST</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path"></a>Path<a class="hash-link" href="#path" title="Direct link to heading">#</a></h5><p>/plugin/saveOrUpdate</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-parameters"></a>Request Parameters<a class="hash-link" href="#request-parameters" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>PluginData</strong></td><td><a href="#PluginData">PluginData</a></td><td>True</td><td></td><td>Plugin data object (pass Json object inside Body)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="plugindata"></a><div id="PluginData">PluginData</div><a class="hash-link" href="#plugindata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td>String</td><td>False</td><td></td><td>plugin id</td></tr><tr><td><strong>name</strong></td><td>String</td><td>True</td><td></td><td>plugin name</td></tr><tr><td><strong>config</strong></td><td>String</td><td>False</td><td></td><td>plugin configuration (Json format)</td></tr><tr><td><strong>role</strong></td><td>String</td><td>False</td><td></td><td>plugin role</td></tr><tr><td><strong>enabled</strong></td><td>Boolean</td><td>False</td><td></td><td>whether to turn on</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="example"></a>Example<a class="hash-link" href="#example" title="Direct link to heading">#</a></h5><p>POST body</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">{"id":3,"name":"divide","enabled":"true"}</span></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"> |
| </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="cleanall"></a>CleanAll<a class="hash-link" href="#cleanall" title="Direct link to heading">#</a></h3><p>Clear all data (plugins, selectors, rules)</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-1"></a>Request Method<a class="hash-link" href="#request-method-1" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-1"></a>Path<a class="hash-link" href="#path-1" title="Direct link to heading">#</a></h5><p>/cleanAll</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="clean-plugin"></a>Clean Plugin<a class="hash-link" href="#clean-plugin" title="Direct link to heading">#</a></h3><p>Clear plugin data（selector, rule）</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-2"></a>Request Method<a class="hash-link" href="#request-method-2" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-2"></a>Path<a class="hash-link" href="#path-2" title="Direct link to heading">#</a></h5><p>/cleanPlugin?name = xxxx</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam"></a>RequestParam<a class="hash-link" href="#requestparam" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>name</strong></td><td>String</td><td>true</td><td></td><td>plugin name</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="delete-plugin"></a>Delete plugin<a class="hash-link" href="#delete-plugin" title="Direct link to heading">#</a></h3><p>Remove plugin data (not included, the selectors and rules data)</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-3"></a>Request Method<a class="hash-link" href="#request-method-3" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-3"></a>Path<a class="hash-link" href="#path-3" title="Direct link to heading">#</a></h5><p>/plugin/delete?name = xxxx</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-1"></a>RequestParam<a class="hash-link" href="#requestparam-1" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>name</strong></td><td>String</td><td>true</td><td></td><td>plugin name</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="delete-all-plugin"></a>Delete All Plugin<a class="hash-link" href="#delete-all-plugin" title="Direct link to heading">#</a></h3><p>Remove all plugin data (not included, the selectors and rules data)</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-4"></a>Request Method<a class="hash-link" href="#request-method-4" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-4"></a>Path<a class="hash-link" href="#path-4" title="Direct link to heading">#</a></h5><p>/plugin/deleteAll</p><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="find-plugin-by-name"></a>Find plugin by name<a class="hash-link" href="#find-plugin-by-name" title="Direct link to heading">#</a></h3><p>Find plugin by name</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-5"></a>Request Method<a class="hash-link" href="#request-method-5" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-5"></a>Path<a class="hash-link" href="#path-5" title="Direct link to heading">#</a></h5><p>/plugin/findByName?name=xxxx</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-2"></a>RequestParam<a class="hash-link" href="#requestparam-2" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>name</strong></td><td>String</td><td>true</td><td></td><td>plugin name</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="save-or-update-selector"></a>Save or Update Selector<a class="hash-link" href="#save-or-update-selector" title="Direct link to heading">#</a></h3><p>Save or Update Selector</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-6"></a>Request Method<a class="hash-link" href="#request-method-6" title="Direct link to heading">#</a></h5><p>POST</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-6"></a>Path<a class="hash-link" href="#path-6" title="Direct link to heading">#</a></h5><p>/plugin/selector/saveOrUpdate</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-3"></a>RequestParam<a class="hash-link" href="#requestparam-3" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>SelectorData</strong></td><td><a href="#SelectorData">SelectorData</a></td><td>True</td><td></td><td>Selector object (pass Json object inside Body)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="selectordata"></a><div id="SelectorData">SelectorData</div><a class="hash-link" href="#selectordata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td>String</td><td>False</td><td></td><td>selector id</td></tr><tr><td><strong>pluginName</strong></td><td>String</td><td>True</td><td></td><td>plugin name</td></tr><tr><td><strong>name</strong></td><td>String</td><td>False</td><td></td><td>Selector name (default is plugin:selector+random number if not filled)</td></tr><tr><td><strong>matchMode</strong></td><td>Integer</td><td>False</td><td></td><td>Matching mode (0:and;1:or), not filled with the default generation And mode</td></tr><tr><td><strong>type</strong></td><td>Integer</td><td>False</td><td></td><td>Traffic type（0: full traffic; 1: custom traffic) do not fill in the default generation of full traffic</td></tr><tr><td><strong>sort</strong></td><td>Integer</td><td>False</td><td></td><td>Sort by, not filled by default generate 10</td></tr><tr><td><strong>enabled</strong></td><td>Boolean</td><td>False</td><td></td><td>Whether to turn on, not fill in the default generation true</td></tr><tr><td><strong>logged</strong></td><td>Boolean</td><td>False</td><td></td><td>Whether or not to print the log, do not fill in the default generated into false</td></tr><tr><td><strong>handle</strong></td><td>String</td><td>False</td><td></td><td>Selector handler (Json objects, depending on each plug-in, different objects are passed)</td></tr><tr><td><strong>conditionList</strong></td><td><a href="#Condition">Condition</a></td><td>False</td><td></td><td>Conditional collection, custom traffic needs to be passed, full traffic does not need to be passed (Json List object)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="condition"></a><div id="Condition">Condition</div><a class="hash-link" href="#condition" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>paramType</strong></td><td>String</td><td>True</td><td></td><td>param type（post，uri，query，host，header，cookie，req_method，domain）</td></tr><tr><td><strong>operator</strong></td><td>String</td><td>True</td><td></td><td>operator （match，=，regex，>，<，contains，SpEL，Groovy，TimeBefore，TimeAfter）</td></tr><tr><td><strong>paramName</strong></td><td>String</td><td>False</td><td></td><td>param mame（The uri parameter type can be passed without）</td></tr><tr><td><strong>paramValue</strong></td><td>Integer</td><td>False</td><td></td><td>param value</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="example-1"></a>Example<a class="hash-link" href="#example-1" title="Direct link to heading">#</a></h5><p>POST body</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">{</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "pluginName": "divide",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "type": 1,</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "handle": "[{\"upstreamUrl\":\"127.0.0.1:8089\"}]",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "conditionDataList": [{</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramType": "uri",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "operator": "match",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramName": null,</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramValue": "/**"</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> }]</span></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"> |
| </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="result"></a>Result<a class="hash-link" href="#result" title="Direct link to heading">#</a></h5><p>Is selector id</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">xxxxx</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="add-selector-and-rules"></a>Add Selector And Rules<a class="hash-link" href="#add-selector-and-rules" title="Direct link to heading">#</a></h3><p>Add a selector with multiple rules</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-7"></a>Request Method<a class="hash-link" href="#request-method-7" title="Direct link to heading">#</a></h5><p>POST</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-7"></a>Path<a class="hash-link" href="#path-7" title="Direct link to heading">#</a></h5><p>/plugin/selectorAndRules</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-4"></a>RequestParam<a class="hash-link" href="#requestparam-4" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>SelectorRulesData</strong></td><td><a href="#SelectorRulesData">SelectorRulesData</a></td><td>True</td><td></td><td>Selector rule object (Body inside pass Json object)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="selectorrulesdata"></a><div id="SelectorRulesData">SelectorRulesData</div><a class="hash-link" href="#selectorrulesdata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>pluginName</strong></td><td>String</td><td>True</td><td></td><td>plugin name</td></tr><tr><td><strong>selectorName</strong></td><td>String</td><td>False</td><td></td><td>Selector name (if not filled in, it is generated by default plugin:selector+random number)</td></tr><tr><td><strong>matchMode</strong></td><td>Integer</td><td>False</td><td></td><td>Matching mode (0:and;1:or), not filled with the default generation And mode</td></tr><tr><td><strong>selectorHandler</strong></td><td>String</td><td>False</td><td></td><td>Selector handler (Json objects, depending on each plug-in, different objects are passed)</td></tr><tr><td><strong>conditionList</strong></td><td><a href="#ConditionData">ConditionData</a></td><td>True</td><td></td><td>Selector condition collection (Json List object)</td></tr><tr><td><strong>ruleDataList</strong></td><td><a href="#RuleLocalData">RuleLocalData</a></td><td>True</td><td></td><td>Rule condition collection (Json List object)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="rulelocaldata"></a><div id="RuleLocalData">RuleLocalData</div><a class="hash-link" href="#rulelocaldata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>ruleName</strong></td><td>String</td><td>False</td><td></td><td>rule name</td></tr><tr><td><strong>ruleHandler</strong></td><td>String</td><td>True</td><td></td><td>Rule handler (different plugins pass different values)）</td></tr><tr><td><strong>matchMode</strong></td><td>Integer</td><td>False</td><td></td><td>Matching pattern (0:and;1:or)</td></tr><tr><td><strong>conditionList</strong></td><td><a href="#ConditionData">ConditionData</a></td><td>True</td><td></td><td>Rule condition collection (Json List object)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="conditiondata"></a><div id="ConditionData">ConditionData</div><a class="hash-link" href="#conditiondata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>paramType</strong></td><td>String</td><td>True</td><td></td><td>param type（post，uri，query，host，header，cookie，req_method，domain）</td></tr><tr><td><strong>operator</strong></td><td>String</td><td>True</td><td></td><td>operator （match，=，regex，>，<，contains，SpEL，Groovy，TimeBefore，TimeAfter）</td></tr><tr><td><strong>paramName</strong></td><td>String</td><td>False</td><td></td><td>param mame（The uri parameter type can be passed without）</td></tr><tr><td><strong>paramValue</strong></td><td>Integer</td><td>False</td><td></td><td>param value</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="example-2"></a>Example<a class="hash-link" href="#example-2" title="Direct link to heading">#</a></h5><p>POST body</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">{</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "pluginName": "divide",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "selectorHandler": "[{\"upstreamUrl\":\"127.0.0.1:8089\"}]",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "conditionDataList": [{</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramType": "uri",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "operator": "match",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramValue": "/http/**"</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> }],</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "ruleDataList": [{</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "ruleHandler": "{\"loadBalance\":\"random\"}",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "conditionDataList": [{</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramType": "uri",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "operator": "=",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramValue": "/http/test/payment"</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> }]</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> }, {</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "ruleHandler": "{\"loadBalance\":\"random\"}",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "conditionDataList": [{</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramType": "uri",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "operator": "=",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramValue": "/http/order/save"</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> }]</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> }]</span></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"> |
| </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="delete-selector"></a>Delete Selector<a class="hash-link" href="#delete-selector" title="Direct link to heading">#</a></h3><p>Delete selectors based on selector id and plugin name</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-8"></a>Request Method<a class="hash-link" href="#request-method-8" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-8"></a>Path<a class="hash-link" href="#path-8" title="Direct link to heading">#</a></h5><p>/plugin/selector/delete?pluginName=xxxx&&id=xxxx</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-5"></a>RequestParam<a class="hash-link" href="#requestparam-5" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>pluginName</strong></td><td>String</td><td>true</td><td></td><td>plugin name</td></tr><tr><td><strong>id</strong></td><td>String</td><td>true</td><td></td><td>selector id</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="find-all-selector"></a>Find All Selector<a class="hash-link" href="#find-all-selector" title="Direct link to heading">#</a></h3><p>Get all selectors by plugin name</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-9"></a>Request Method<a class="hash-link" href="#request-method-9" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-9"></a>Path<a class="hash-link" href="#path-9" title="Direct link to heading">#</a></h5><p>/plugin/selector/findList?pluginName=xxxx</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-6"></a>RequestParam<a class="hash-link" href="#requestparam-6" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>pluginName</strong></td><td>String</td><td>true</td><td></td><td>plugin name</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="save-or-update-rule-data"></a>Save or Update Rule Data<a class="hash-link" href="#save-or-update-rule-data" title="Direct link to heading">#</a></h3><p>Save or Update Rule Data</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-10"></a>Request Method<a class="hash-link" href="#request-method-10" title="Direct link to heading">#</a></h5><p>POST</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-10"></a>Path<a class="hash-link" href="#path-10" title="Direct link to heading">#</a></h5><p>/plugin/rule/saveOrUpdate</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-7"></a>RequestParam<a class="hash-link" href="#requestparam-7" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>RuleData</strong></td><td><a href="#RuleData">RuleData</a></td><td>True</td><td></td><td>Rule object (pass Json object inside Body)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="ruledata"></a><div id="RuleData">RuleData</div><a class="hash-link" href="#ruledata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td>String</td><td>False</td><td></td><td>rule id</td></tr><tr><td><strong>pluginName</strong></td><td>String</td><td>True</td><td></td><td>plugin name</td></tr><tr><td><strong>name</strong></td><td>String</td><td>False</td><td></td><td>Rule name (default generation if not filled plugin:rule+random number)</td></tr><tr><td><strong>selectorId</strong></td><td>String</td><td>True</td><td></td><td>Selector id</td></tr><tr><td><strong>matchMode</strong></td><td>Integer</td><td>False</td><td></td><td>Matching mode (0:and;1:or), not filled with the default generation And mode</td></tr><tr><td><strong>sort</strong></td><td>Integer</td><td>False</td><td></td><td>Sort by , not filled by default generate 10</td></tr><tr><td><strong>enabled</strong></td><td>Boolean</td><td>False</td><td></td><td>Whether to turn on, not fill in the default generation true</td></tr><tr><td><strong>logged</strong></td><td>Boolean</td><td>False</td><td></td><td>Whether or not to print the log, do not fill in the default generated into false</td></tr><tr><td><strong>handle</strong></td><td>String</td><td>False</td><td></td><td>Rule handler (Json objects, depending on each plug-in, different objects are passed)</td></tr><tr><td><strong>conditionList</strong></td><td><a href="#ConditionData">ConditionData</a></td><td>False</td><td></td><td>Conditional collections (Json List objects)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="conditionlist"></a><div id="conditionList">conditionList</div><a class="hash-link" href="#conditionlist" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>paramType</strong></td><td>String</td><td>True</td><td></td><td>param type（post，uri，query，host，header，cookie，req_method，domain）</td></tr><tr><td><strong>operator</strong></td><td>String</td><td>True</td><td></td><td>operator （match，=，regex，>，<，contains，SpEL，Groovy，TimeBefore，TimeAfter）</td></tr><tr><td><strong>paramName</strong></td><td>String</td><td>False</td><td></td><td>param mame（The uri parameter type can be passed without）</td></tr><tr><td><strong>paramValue</strong></td><td>Integer</td><td>False</td><td></td><td>param value</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="example-3"></a>Example<a class="hash-link" href="#example-3" title="Direct link to heading">#</a></h5><p>POST body</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">{</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "pluginName": "divide",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "selectorId": 123456,</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "handle": "{\"loadBalance\":\"random\"}",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "conditionDataList": [{</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramType": "uri",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "operator": "=",</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> "paramValue": "/test"</span></span><span class="token-line" style="color:#393A34"><span class="token plain"> }]</span></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"> |
| </span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="result-1"></a>Result<a class="hash-link" href="#result-1" title="Direct link to heading">#</a></h5><p>Is rule id</p><div class="codeBlockContainer_J+bg"><div class="codeBlockContent_csEI"><pre tabindex="0" class="prism-code language-undefined codeBlock_rtdJ thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_1zSZ"><span class="token-line" style="color:#393A34"><span class="token plain">xxxxx</span></span></code></pre><button type="button" aria-label="Copy code to clipboard" class="copyButton_M3SB clean-btn">Copy</button></div></div><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="delete-rule-data"></a>Delete rule data<a class="hash-link" href="#delete-rule-data" title="Direct link to heading">#</a></h3><p>Delete rules based on selector id and rule id</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-11"></a>Request Method<a class="hash-link" href="#request-method-11" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-11"></a>Path<a class="hash-link" href="#path-11" title="Direct link to heading">#</a></h5><p>/plugin/rule/delete?selectorId=xxxx&&id=xxxx</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-8"></a>RequestParam<a class="hash-link" href="#requestparam-8" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>selectorId</strong></td><td>String</td><td>true</td><td></td><td>selector ID</td></tr><tr><td><strong>id</strong></td><td>String</td><td>true</td><td></td><td>rule ID</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="find-rule-data-list"></a>Find Rule data List<a class="hash-link" href="#find-rule-data-list" title="Direct link to heading">#</a></h3><p>Get all rules by selector ID</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-12"></a>Request Method<a class="hash-link" href="#request-method-12" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-12"></a>Path<a class="hash-link" href="#path-12" title="Direct link to heading">#</a></h5><p>/plugin/rule/findList?selectorId=xxxx</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-9"></a>RequestParam<a class="hash-link" href="#requestparam-9" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>selectorId</strong></td><td>String</td><td>true</td><td></td><td>selector id</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="meta-data"></a>Meta data<a class="hash-link" href="#meta-data" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="save-or-update"></a>Save Or Update<a class="hash-link" href="#save-or-update" title="Direct link to heading">#</a></h3><p>Save Or Update Meta data</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-13"></a>Request Method<a class="hash-link" href="#request-method-13" title="Direct link to heading">#</a></h5><p>POST</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-13"></a>Path<a class="hash-link" href="#path-13" title="Direct link to heading">#</a></h5><p>/meta/saveOrUpdate</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-10"></a>RequestParam<a class="hash-link" href="#requestparam-10" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>MetaData</strong></td><td><a href="#MetaData">MetaData</a></td><td>True</td><td></td><td>Metadata object (pass Json object inside Body)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="metadata"></a><div id="MetaData">MetaData</div><a class="hash-link" href="#metadata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>id</strong></td><td>String</td><td>False</td><td></td><td>ID</td></tr><tr><td><strong>appName</strong></td><td>String</td><td>True</td><td></td><td>app name</td></tr><tr><td><strong>contextPath</strong></td><td>String</td><td>True</td><td></td><td>contextPath</td></tr><tr><td><strong>path</strong></td><td>String</td><td>True</td><td></td><td>path</td></tr><tr><td><strong>rpcType</strong></td><td>String</td><td>True</td><td></td><td>rpc type（dubbo，sofa，tars，springCloud，motan，grpc）</td></tr><tr><td><strong>serviceName</strong></td><td>String</td><td>True</td><td></td><td>service name</td></tr><tr><td><strong>methodName</strong></td><td>String</td><td>True</td><td></td><td>method name</td></tr><tr><td><strong>parameterTypes</strong></td><td>String</td><td>True</td><td></td><td>parameter types</td></tr><tr><td><strong>rpcExt</strong></td><td>String</td><td>False</td><td></td><td>rpc extension parameters (json objects)</td></tr><tr><td><strong>enabled</strong></td><td>Boolean</td><td>False</td><td></td><td>Whether to turn on</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="delete"></a>Delete<a class="hash-link" href="#delete" title="Direct link to heading">#</a></h3><p>Delete Meta data</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-14"></a>Request Method<a class="hash-link" href="#request-method-14" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-14"></a>Path<a class="hash-link" href="#path-14" title="Direct link to heading">#</a></h5><p>/meta/delete?rpcType=xxxx&&path=xxx</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-11"></a>RequestParam<a class="hash-link" href="#requestparam-11" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>rpcType</strong></td><td>String</td><td>true</td><td></td><td>rpc type（dubbo，sofa，tars，springCloud，motan，grpc）</td></tr><tr><td><strong>path</strong></td><td>String</td><td>true</td><td></td><td>path</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="app-sign-data"></a>App Sign Data<a class="hash-link" href="#app-sign-data" title="Direct link to heading">#</a></h2><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="save-or-update-1"></a>Save Or Update<a class="hash-link" href="#save-or-update-1" title="Direct link to heading">#</a></h3><p>Save Or Update App Sign Data</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-15"></a>Request Method<a class="hash-link" href="#request-method-15" title="Direct link to heading">#</a></h5><p>POST</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-15"></a>Path<a class="hash-link" href="#path-15" title="Direct link to heading">#</a></h5><p>/auth/saveOrUpdate</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-12"></a>RequestParam<a class="hash-link" href="#requestparam-12" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>AppAuthData</strong></td><td><a href="#AppAuthData">AppAuthData</a></td><td>True</td><td></td><td>Signature object (Json object passed inside the Body)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="appauthdata"></a><div id="AppAuthData">AppAuthData</div><a class="hash-link" href="#appauthdata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>appKey</strong></td><td>String</td><td>True</td><td></td><td>app key</td></tr><tr><td><strong>appSecret</strong></td><td>String</td><td>True</td><td></td><td>app secret</td></tr><tr><td><strong>enabled</strong></td><td>Boolean</td><td>False</td><td></td><td>Whether to turn on</td></tr><tr><td><strong>open</strong></td><td>Boolean</td><td>False</td><td></td><td>is open</td></tr><tr><td><strong>paramDataList</strong></td><td><a href="#AuthParamData">AuthParamData</a></td><td>false</td><td></td><td>Parameter set, open is true when you need to pass (Json list object)</td></tr><tr><td><strong>AuthPathData</strong></td><td><a href="#AuthPathData">AuthPathData</a></td><td>false</td><td></td><td>Path collection, open is true when you need to pass (Json list object)</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="authparamdata"></a><div id="AuthParamData">AuthParamData</div><a class="hash-link" href="#authparamdata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>appName</strong></td><td>String</td><td>True</td><td></td><td>app name</td></tr><tr><td><strong>appParam</strong></td><td>String</td><td>True</td><td></td><td>app param</td></tr></tbody></table><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="authpathdata"></a><div id="AuthPathData">AuthPathData</div><a class="hash-link" href="#authpathdata" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>appName</strong></td><td>String</td><td>True</td><td></td><td>app name</td></tr><tr><td><strong>path</strong></td><td>String</td><td>True</td><td></td><td>path</td></tr><tr><td><strong>enabled</strong></td><td>Boolean</td><td>False</td><td></td><td>Whether to turn on</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="delete-1"></a>Delete<a class="hash-link" href="#delete-1" title="Direct link to heading">#</a></h3><p>Delete App Sign Data</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="request-method-16"></a>Request Method<a class="hash-link" href="#request-method-16" title="Direct link to heading">#</a></h5><p>GET</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="path-16"></a>Path<a class="hash-link" href="#path-16" title="Direct link to heading">#</a></h5><p>/auth/delete?appKey=xxxx</p><h5><a aria-hidden="true" tabindex="-1" class="anchor enhancedAnchor_WiXH" id="requestparam-13"></a>RequestParam<a class="hash-link" href="#requestparam-13" title="Direct link to heading">#</a></h5><table><thead><tr><th>Name</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><strong>appKey</strong></td><td>String</td><td>true</td><td></td><td>app key</td></tr></tbody></table></div><footer class="row docusaurus-mt-lg"><div class="col"><a href="https://github.com/apache/shenyu-website/edit/main/versioned_docs/version-2.4.2/developer/local-model.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_mS5F" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_wj+Z"></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><div class="pagination-nav__item"><a class="pagination-nav__link" href="/docs/2.4.2/developer/integration-test"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">« Run Integration Test Locally</div></a></div><div class="pagination-nav__item pagination-nav__item--next"><a class="pagination-nav__link" href="/docs/2.4.2/developer/shenyu-optimize"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">ShenYu Optimize »</div></a></div></nav></div></div><div class="col col--3"><div class="tableOfContents_vrFS thin-scrollbar"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#description" class="table-of-contents__link">Description</a></li><li><a href="#plugin" class="table-of-contents__link">Plugin</a><ul><li><a href="#saveorupdate" class="table-of-contents__link">saveOrUpdate</a></li><li><a href="#cleanall" class="table-of-contents__link">CleanAll</a></li><li><a href="#clean-plugin" class="table-of-contents__link">Clean Plugin</a></li><li><a href="#delete-plugin" class="table-of-contents__link">Delete plugin</a></li><li><a href="#delete-all-plugin" class="table-of-contents__link">Delete All Plugin</a></li><li><a href="#find-plugin-by-name" class="table-of-contents__link">Find plugin by name</a></li><li><a href="#save-or-update-selector" class="table-of-contents__link">Save or Update Selector</a></li><li><a href="#add-selector-and-rules" class="table-of-contents__link">Add Selector And Rules</a></li><li><a href="#delete-selector" class="table-of-contents__link">Delete Selector</a></li><li><a href="#find-all-selector" class="table-of-contents__link">Find All Selector</a></li><li><a href="#save-or-update-rule-data" class="table-of-contents__link">Save or Update Rule Data</a></li><li><a href="#delete-rule-data" class="table-of-contents__link">Delete rule data</a></li><li><a href="#find-rule-data-list" class="table-of-contents__link">Find Rule data List</a></li></ul></li><li><a href="#meta-data" class="table-of-contents__link">Meta data</a><ul><li><a href="#save-or-update" class="table-of-contents__link">Save Or Update</a></li><li><a href="#delete" class="table-of-contents__link">Delete</a></li></ul></li><li><a href="#app-sign-data" class="table-of-contents__link">App Sign Data</a><ul><li><a href="#save-or-update-1" class="table-of-contents__link">Save Or Update</a></li><li><a href="#delete-1" class="table-of-contents__link">Delete</a></li></ul></li></ul></div></div></div></div></main></div></div></div> |
| <script src="/assets/js/runtime~main.490de106.js"></script> |
| <script src="/assets/js/main.cb386500.js"></script> |
| </body> |
| </html> |
