| <!doctype html> |
| <html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-1.6.0 plugin-docs plugin-id-default docs-doc-id-modules/tubemq/http_access_api"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v2.3.1"> |
| <title data-rh="true">HTTP API | Apache InLong</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://inlong.apache.org/docs/1.6.0/modules/tubemq/http_access_api"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="1.6.0"><meta data-rh="true" name="docusaurus_tag" content="docs-default-1.6.0"><meta data-rh="true" name="docsearch:version" content="1.6.0"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-1.6.0"><meta data-rh="true" property="og:title" content="HTTP API | Apache InLong"><meta data-rh="true" name="description" content="1 Master metadata configuration API"><meta data-rh="true" property="og:description" content="1 Master metadata configuration API"><link data-rh="true" rel="icon" href="/img/logo.svg"><link data-rh="true" rel="canonical" href="https://inlong.apache.org/docs/1.6.0/modules/tubemq/http_access_api"><link data-rh="true" rel="alternate" href="https://inlong.apache.org/docs/1.6.0/modules/tubemq/http_access_api" hreflang="en"><link data-rh="true" rel="alternate" href="https://inlong.apache.org/zh-CN/docs/1.6.0/modules/tubemq/http_access_api" hreflang="zh-CN"><link data-rh="true" rel="alternate" href="https://inlong.apache.org/docs/1.6.0/modules/tubemq/http_access_api" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://YUW9QEL53E-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache InLong RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache InLong Atom Feed"> |
| |
| |
| |
| <link rel="search" type="application/opensearchdescription+xml" title="Apache InLong" href="/opensearch.xml"> |
| |
| |
| |
| <script src="https://www.apachecon.com/event-images/snippet.js" async></script><link rel="stylesheet" href="/assets/css/styles.c64edd51.css"> |
| <link rel="preload" href="/assets/js/runtime~main.63c98e82.js" as="script"> |
| <link rel="preload" href="/assets/js/main.070aef2a.js" as="script"> |
| </head> |
| <body class="navigation-with-keyboard"> |
| <script>!function(){function e(e){document.documentElement.setAttribute("data-theme",e)}var t=function(){var e=null;try{e=localStorage.getItem("theme")}catch(e){}return e}();null!==t?e(t):window.matchMedia("(prefers-color-scheme: dark)").matches?e("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,e("light"))}()</script><div id="__docusaurus"> |
| <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><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="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Apache" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.svg" alt="Apache" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache InLong</b></a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/introduction">Docs</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/next/introduction">Next</a></li><li><a class="dropdown__link" href="/docs/introduction">1.11.0</a></li><li><a class="dropdown__link" href="/docs/1.10.0/introduction">1.10.0</a></li><li><a class="dropdown__link" href="/docs/1.9.0/introduction">1.9.0</a></li><li><a class="dropdown__link" href="/docs/1.8.0/introduction">1.8.0</a></li><li><a class="dropdown__link" href="/versions/">All versions</a></li></ul></div><a class="navbar__item navbar__link" href="/downloads">Download</a><a class="navbar__item navbar__link" href="/community/how-to-contribute">Community</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/team">Team</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Apache Software 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><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/docs/1.6.0/modules/tubemq/http_access_api" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/zh-CN/docs/1.6.0/modules/tubemq/http_access_api" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh-CN">简体中文</a></li></ul></div><a href="https://github.com/apache/inlong" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><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"><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 id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/1.6.0/introduction">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/design_and_concept/basic_concept">Design and Concept</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/quick_start/how_to_build">Quick Start</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/deployment/standalone">Deployment</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/1.6.0/modules/agent/overview">Components</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/1.6.0/modules/agent/overview">Agent</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/1.6.0/modules/dataproxy/overview">DataProxy</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/1.6.0/modules/tubemq/overview">TubeMQ</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/overview">Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/quick_start">Quick Start</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/producer_example">Producer Example</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/consumer_example">Consumer Example</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-3 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/1.6.0/modules/tubemq/tubemq-manager/overview">tubemq-manager</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/client_partition_assign_introduction">client partition assign</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/client_rpc">Client RPC</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/clients_java">TubeMQ JAVA SDK API</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/configure_introduction">Configuration</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/console_introduction">Console Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/error_code">Error Code</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/1.6.0/modules/tubemq/http_access_api">HTTP API</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/tubemq_metrics">TubeMQ Metrics</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/1.6.0/modules/tubemq/tubemq_perf_test_vs_Kafka">TubeMQ VS Kafka</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/1.6.0/modules/sort/overview">Sort</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/1.6.0/modules/manager/overview">Manager</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/1.6.0/modules/dashboard/overview">Dashboard</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/1.6.0/modules/sort-standalone/overview">Sort Standalone</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/docs/1.6.0/modules/audit/overview">Audit</a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/data_node/extract_node/overview">Data Nodes</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/sdk/dataproxy-sdk/cpp">SDK</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/user_guide/dashboard_usage">User Guide</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/development/inlong_msg">Development</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/1.6.0/administration/user_management">Administration</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/1.6.0/contact">Contact Us</a></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="theme-doc-version-banner alert alert--warning margin-bottom--md" role="alert"><div>This is documentation for <!-- -->Apache InLong<!-- --> <b>1.6.0</b>, which is no longer actively maintained.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/docs/modules/tubemq/http_access_api">latest version</a></b> (<!-- -->1.11.0<!-- -->).</div></div><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Components</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">TubeMQ</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">HTTP API</span><meta itemprop="position" content="3"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 1.6.0</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>HTTP API</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="1-master-metadata-configuration-api">1 Master metadata configuration API<a href="#1-master-metadata-configuration-api" class="hash-link" aria-label="Direct link to 1 Master metadata configuration API" title="Direct link to 1 Master metadata configuration API"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="11-cluster-management-api">1.1 Cluster management API<a href="#11-cluster-management-api" class="hash-link" aria-label="Direct link to 1.1 Cluster management API" title="Direct link to 1.1 Cluster management API"></a></h3><h4 class="anchor anchorWithStickyNavbar_LWe7" id="111-admin_online_broker_configure">1.1.1 <code>admin_online_broker_configure</code><a href="#111-admin_online_broker_configure" class="hash-link" aria-label="Direct link to 111-admin_online_broker_configure" title="Direct link to 111-admin_online_broker_configure"></a></h4><p>The online configuration of the Brokers are new or offline. The configuration of Topics are distributed to related Brokers as well.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerId</td><td>yes</td><td>The broker ID. It supports bulk brokerId which is separated by <code>,</code>. The maximum number of a bulk is <code>50</code>. The brokerId should be distinct in case of bulk value</td><td>int</td></tr><tr><td>modifyUser</td><td>yes</td><td>The user who executes this</td><td>String</td></tr><tr><td>modifyDate</td><td>no</td><td>The modify date in the format of "yyyyMMddHHmmss"</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>The authorization key</td><td>String</td></tr></tbody></table><p><strong>Response</strong></p><table><thead><tr><th>name</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>code</td><td>Returns <code>0</code> if success, otherwise failed</td><td>int</td></tr><tr><td>errMsg</td><td>"OK" if success, other return error message</td><td>string</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="112-admin_reload_broker_configure">1.1.2 <code>admin_reload_broker_configure</code><a href="#112-admin_reload_broker_configure" class="hash-link" aria-label="Direct link to 112-admin_reload_broker_configure" title="Direct link to 112-admin_reload_broker_configure"></a></h4><p>Update the configuration of the Brokers which are <strong>online</strong>. The new configuration will be published to Broker server, it |
| will return error if the broker is offline.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerId</td><td>yes</td><td>the id of broker. It supports bulk brokerId which separated by <code>,</code>. The maximum <br> number of a bulk is 50. The brokerId should be distinct in case of bulk value</td><td>int</td></tr><tr><td>modifyUser</td><td>yes</td><td>the user who executes this</td><td>String</td></tr><tr><td>modifyDate</td><td>no</td><td>the modify date in the format of "yyyyMMddHHmmss"</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorization key</td><td>String</td></tr></tbody></table><p><strong>Response</strong></p><table><thead><tr><th>name</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>code</td><td>return 0 if success, otherwise failed</td><td>int</td></tr><tr><td>errMsg</td><td>"OK" if success, other return error message</td><td>string</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="113-admin_offline_broker_configure">1.1.3 <code>admin_offline_broker_configure</code><a href="#113-admin_offline_broker_configure" class="hash-link" aria-label="Direct link to 113-admin_offline_broker_configure" title="Direct link to 113-admin_offline_broker_configure"></a></h4><p>Offline the configuration of the Brokers which are <strong>online</strong>. It should be called before Broker offline or retired. |
| The Broker processes can be terminated once all offline tasks are done.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerId</td><td>yes</td><td>the id of broker. It supports bulk brokerId which separated by <code>,</code>. The maximum <br> number of a bulk is 50. The brokerId should be distinct in case of bulk value</td><td>int</td></tr><tr><td>modifyUser</td><td>yes</td><td>the user who executes this</td><td>String</td></tr><tr><td>modifyDate</td><td>no</td><td>the modify date in the format of "yyyyMMddHHmmss"</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorization key</td><td>String</td></tr></tbody></table><p><strong>Response</strong></p><table><thead><tr><th>name</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>code</td><td>return 0 if success, otherwise failed</td><td>int</td></tr><tr><td>errMsg</td><td>"OK" if success, other return error message</td><td>string</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="114-admin_set_broker_read_or_write">1.1.4 <code>admin_set_broker_read_or_write</code><a href="#114-admin_set_broker_read_or_write" class="hash-link" aria-label="Direct link to 114-admin_set_broker_read_or_write" title="Direct link to 114-admin_set_broker_read_or_write"></a></h4><p>Set Broker into a read-only or write-only state. Only Brokers are online and idle can be handled.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerId</td><td>yes</td><td>the id of broker. It supports bulk brokerId which separated by <code>,</code>. The maximum <br> number of a bulk is 50. The brokerId should be distinct in case of bulk value</td><td>int</td></tr><tr><td>isAcceptPublish</td><td>yes</td><td>whether the brokers accept publish requests, default is true</td><td>Boolean</td></tr><tr><td>isAcceptSubscribe</td><td>no</td><td>whether the brokers accept subscribe requests, default is true</td><td>Boolean</td></tr><tr><td>modifyUser</td><td>yes</td><td>the user who request the change, default is creator</td><td>String</td></tr><tr><td>modifyDate</td><td>no</td><td>the modify date in the format of "yyyyMMddHHmmss"</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorization key</td><td>String</td></tr></tbody></table><p><strong>Response</strong></p><table><thead><tr><th>name</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>code</td><td>return 0 if success, otherwise failed</td><td>int</td></tr><tr><td>errMsg</td><td>"OK" if success, other return error message</td><td>string</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="115-admin_query_broker_run_status">1.1.5 <code>admin_query_broker_run_status</code><a href="#115-admin_query_broker_run_status" class="hash-link" aria-label="Direct link to 115-admin_query_broker_run_status" title="Direct link to 115-admin_query_broker_run_status"></a></h4><p>Query Broker status. Only the Brokers processes are <strong>offline</strong> and idle can be terminated.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerId</td><td>yes</td><td>the id of broker. It supports bulk brokerId which separated by <code>,</code>. The maximum <br> number of a bulk is 50. The brokerId should be distinct in case of bulk value</td><td>int</td></tr><tr><td>onlyAbnormal</td><td>no</td><td>only report abnormal set, default is false</td><td>Boolean</td></tr><tr><td>onlyAutoForbidden</td><td>no</td><td>only auto forbidden set, default is false</td><td>Boolean</td></tr><tr><td>onlyEnableTLS</td><td>no</td><td>only enable TLS set, default is false</td><td>Boolean</td></tr><tr><td>withDetail</td><td>yes</td><td>whether it needs detail, default is false</td><td>Boolean</td></tr></tbody></table><p><strong>Response</strong></p><table><thead><tr><th>name</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>code</td><td>return 0 if success, otherwise failed</td><td>int</td></tr><tr><td>errMsg</td><td>"OK" if success, other return error message</td><td>string</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="116-admin_release_broker_autoforbidden_status">1.1.6 <code>admin_release_broker_autoforbidden_status</code><a href="#116-admin_release_broker_autoforbidden_status" class="hash-link" aria-label="Direct link to 116-admin_release_broker_autoforbidden_status" title="Direct link to 116-admin_release_broker_autoforbidden_status"></a></h4><p>Release the brokers' auto forbidden status.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerId</td><td>yes</td><td>the id of broker. It supports bulk brokerId which separated by <code>,</code>. The maximum <br> number of a bulk is 50. The brokerId should be distinct in case of bulk value</td><td>int</td></tr><tr><td>realReason</td><td>yes</td><td>the reason of why it needs to release</td><td>String</td></tr><tr><td>modifyUser</td><td>yes</td><td>the user who request the change, default is creator</td><td>String</td></tr><tr><td>modifyDate</td><td>no</td><td>the modify date in the format of "yyyyMMddHHmmss"</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorization key</td><td>String</td></tr></tbody></table><p>Response</p><table><thead><tr><th>name</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>code</td><td>return 0 if success, otherwise failed</td><td>int</td></tr><tr><td>errMsg</td><td>"OK" if success, other return error message</td><td>string</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="117-admin_query_master_group_info">1.1.7 <code>admin_query_master_group_info</code><a href="#117-admin_query_master_group_info" class="hash-link" aria-label="Direct link to 117-admin_query_master_group_info" title="Direct link to 117-admin_query_master_group_info"></a></h4><p>Query the detail of master cluster nodes.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="118-admin_transfer_current_master">1.1.8 <code>admin_transfer_current_master</code><a href="#118-admin_transfer_current_master" class="hash-link" aria-label="Direct link to 118-admin_transfer_current_master" title="Direct link to 118-admin_transfer_current_master"></a></h4><p>Set current master node as backup node, let it select another master.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="19-groupadminsh">1.9 <code>groupAdmin.sh</code><a href="#19-groupadminsh" class="hash-link" aria-label="Direct link to 19-groupadminsh" title="Direct link to 19-groupadminsh"></a></h4><p>Clean the invalid node inside master group.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>groupName</td><td>yes</td><td>the name of master group</td><td>String</td></tr><tr><td>helperHost</td><td>yes</td><td>the address of an online master node which will connect. The format is <code>ip:port</code></td><td>String</td></tr><tr><td>nodeName2Remove</td><td>no</td><td>the group node to be clean</td><td>String</td></tr></tbody></table><p>Response</p><table><thead><tr><th>name</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>code</td><td>return 0 if success, otherwise failed</td><td>int</td></tr><tr><td>errMsg</td><td>"OK" if success, other return error message</td><td>string</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="12-broker-node-configuration-api">1.2 Broker node configuration API<a href="#12-broker-node-configuration-api" class="hash-link" aria-label="Direct link to 1.2 Broker node configuration API" title="Direct link to 1.2 Broker node configuration API"></a></h3><h4 class="anchor anchorWithStickyNavbar_LWe7" id="121-admin_add_broker_configure">1.2.1 <code>admin_add_broker_configure</code><a href="#121-admin_add_broker_configure" class="hash-link" aria-label="Direct link to 121-admin_add_broker_configure" title="Direct link to 121-admin_add_broker_configure"></a></h4><p>Add broker default configuration (not include topic info). It will be effective after calling load API.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerIp</td><td>yes</td><td>a ip v4 address</td><td>string</td></tr><tr><td>brokerPort</td><td>no</td><td>the port of broker. Default is 8123</td><td>Int</td></tr><tr><td>brokerId</td><td>yes</td><td>the id of the broker, its default value is 0. If brokerId is not zero, it ignores brokerIp field</td><td>String</td></tr><tr><td>deleteWhen</td><td>no</td><td>the default deleting time of the topic data. The format should like cronjob form <code>0 0 6, 18 * * ?</code></td><td>String</td></tr><tr><td>deletePolicy</td><td>no</td><td>the default policy for deleting, the default policy is "delete, 168"</td><td>String</td></tr><tr><td>numPartitions</td><td>no</td><td>the default partition number of a default topic on the broker. Default 1</td><td>Int</td></tr><tr><td>unflushThreshold</td><td>no</td><td>the maximum message number which allows in memory. It has to be flushed to disk if the number exceed this value. Default 1000</td><td>Int</td></tr><tr><td>numTopicStores</td><td>no</td><td>the number of data block and partition group allowed to create, default 1. If it is larger than 1, the partition number and topic number should be mapping with this value</td><td>Int</td></tr><tr><td>unflushInterval</td><td>no</td><td>the maximum interval for unflush, default 1000ms</td><td>Int</td></tr><tr><td>memCacheMsgCntInK</td><td>no</td><td>the max cached message package, default is 10, the unit is K</td><td>Int</td></tr><tr><td>memCacheMsgSizeInMB</td><td>no</td><td>the max cache message size in MB, default 3</td><td>Int</td></tr><tr><td>memCacheFlushIntvl</td><td>no</td><td>the max unflush interval in ms, default 20000</td><td>Int</td></tr><tr><td>brokerTLSPort</td><td>no</td><td>the port of TLS of the broker, it has no default value</td><td>Int</td></tr><tr><td>acceptPublish</td><td>no</td><td>whether the broker accept publish, default true</td><td>Boolean</td></tr><tr><td>acceptSubscribe</td><td>no</td><td>whether the broker accept subscribe, default true</td><td>Boolean</td></tr><tr><td>createUser</td><td>yes</td><td>the create user</td><td>String</td></tr><tr><td>createDate</td><td>yes</td><td>the create date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="122-admin_batch_add_broker_configure">1.2.2 <code>admin_batch_add_broker_configure</code><a href="#122-admin_batch_add_broker_configure" class="hash-link" aria-label="Direct link to 122-admin_batch_add_broker_configure" title="Direct link to 122-admin_batch_add_broker_configure"></a></h4><p>Add broker default configuration in batch (not include topic info). It will be effective after calling load API.</p><p>This API take a json string referred as <code>brokerJsonSet</code> as input parameter. The content of Json contains the configuration lists in |
| <code>admin_add_broker_configure</code></p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerJsonSet</td><td>yes</td><td>the parameter for the configuration</td><td>String</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>yes</td><td>the create date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="123-admin_update_broker_configure">1.2.3 <code>admin_update_broker_configure</code><a href="#123-admin_update_broker_configure" class="hash-link" aria-label="Direct link to 123-admin_update_broker_configure" title="Direct link to 123-admin_update_broker_configure"></a></h4><p>Update broker default configuration (not include topic info). It will be effective after calling load API.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerId</td><td>yes</td><td>the id of the broker. It supports bulk operation by providing id set here. The brokerId should separated by <code>,</code> and be distinct</td><td>String</td></tr><tr><td>brokerPort</td><td>no</td><td>the port of broker. Default is 8123</td><td>Int</td></tr><tr><td>deleteWhen</td><td>no</td><td>the default deleting time of the topic data. The format should like cronjob form <code>0 0 6, 18 * * ?</code></td><td>String</td></tr><tr><td>deletePolicy</td><td>no</td><td>the default policy for deleting, the default policy is "delete, 168"</td><td>String</td></tr><tr><td>numPartitions</td><td>no</td><td>the default partition number of a default topic on the broker. Default 1</td><td>Int</td></tr><tr><td>unflushThreshold</td><td>no</td><td>the maximum message number which allows in memory. It has to be flushed to disk if the number exceed this value. Default 1000</td><td>Int</td></tr><tr><td>numTopicStores</td><td>no</td><td>the number of data block and partition group allowed to create, default 1. If it is larger than 1, the partition number and topic number should be mapping with this value</td><td>Int</td></tr><tr><td>unflushInterval</td><td>no</td><td>the maximum interval for unflush, default 1000ms</td><td>Int</td></tr><tr><td>memCacheMsgCntInK</td><td>no</td><td>the max cached message package, default is 10, the unit is K</td><td>Int</td></tr><tr><td>memCacheMsgSizeInMB</td><td>no</td><td>the max cache message size in MB, default 3</td><td>Int</td></tr><tr><td>memCacheFlushIntvl</td><td>no</td><td>the max unflush interval in ms, default 20000</td><td>Int</td></tr><tr><td>brokerTLSPort</td><td>no</td><td>the port of TLS of the broker, it has no default value</td><td>Int</td></tr><tr><td>acceptPublish</td><td>no</td><td>whether the broker accept publish, default true</td><td>Boolean</td></tr><tr><td>acceptSubscribe</td><td>no</td><td>whether the broker accept subscribe, default true</td><td>Boolean</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>yes</td><td>the modify date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="124-admin_query_broker_configure">1.2.4 <code>admin_query_broker_configure</code><a href="#124-admin_query_broker_configure" class="hash-link" aria-label="Direct link to 124-admin_query_broker_configure" title="Direct link to 124-admin_query_broker_configure"></a></h4><p>Query the broker configuration.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerId</td><td>yes</td><td>the id of the broker. It supports bulk operation by providing id set here. The brokerId should separated by <code>,</code> and be distinct</td><td>String</td></tr><tr><td>brokerPort</td><td>no</td><td>the port of broker. Default is 8123</td><td>Int</td></tr><tr><td>deleteWhen</td><td>no</td><td>the default deleting time of the topic data. The format should like cronjob form <code>0 0 6, 18 * * ?</code></td><td>String</td></tr><tr><td>deletePolicy</td><td>no</td><td>the default policy for deleting, the default policy is "delete, 168"</td><td>String</td></tr><tr><td>numPartitions</td><td>no</td><td>the default partition number of a default topic on the broker. Default 1</td><td>Int</td></tr><tr><td>unflushThreshold</td><td>no</td><td>the maximum message number which allows in memory. It has to be flushed to disk if the number exceed this value. Default 1000</td><td>Int</td></tr><tr><td>numTopicStores</td><td>no</td><td>the number of data block and partition group allowed to create, default 1. If it is larger than 1, the partition number and topic number should be mapping with this value</td><td>Int</td></tr><tr><td>unflushInterval</td><td>no</td><td>the maximum interval for unflush, default 1000ms</td><td>Int</td></tr><tr><td>memCacheMsgCntInK</td><td>no</td><td>the max cached message package, default is 10, the unit is K</td><td>Int</td></tr><tr><td>memCacheMsgSizeInMB</td><td>no</td><td>the max cache message size in MB, default 3</td><td>Int</td></tr><tr><td>memCacheFlushIntvl</td><td>no</td><td>the max unflush interval in ms, default 20000</td><td>Int</td></tr><tr><td>brokerTLSPort</td><td>no</td><td>the port of TLS of the broker, it has no default value</td><td>Int</td></tr><tr><td>acceptPublish</td><td>no</td><td>whether the broker accept publish, default true</td><td>Boolean</td></tr><tr><td>acceptSubscribe</td><td>no</td><td>whether the broker accept subscribe, default true</td><td>Boolean</td></tr><tr><td>createUser</td><td>yes</td><td>the creator to be query</td><td>String</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier to be query</td><td>String</td></tr><tr><td>topicStatusId</td><td>yes</td><td>the status of topic record</td><td>int</td></tr><tr><td>withTopic</td><td>no</td><td>whether it needs topic configuration</td><td>Boolean</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="125-admin_delete_broker_configure">1.2.5 <code>admin_delete_broker_configure</code><a href="#125-admin_delete_broker_configure" class="hash-link" aria-label="Direct link to 125-admin_delete_broker_configure" title="Direct link to 125-admin_delete_broker_configure"></a></h4><p>Delete the broker's default configuration. It requires the related topic configuration to be delete at first, and the broker should be offline. </p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>brokerId</td><td>yes</td><td>the id of the broker. It supports bulk operation by providing id set here. The brokerId should separated by <code>,</code> and be distinct</td><td>String</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>no</td><td>the modifying date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>isReserveData</td><td>no</td><td>whether to reserve production data, default false</td><td>Boolean</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="13-topic-configuration-api">1.3 Topic configuration API<a href="#13-topic-configuration-api" class="hash-link" aria-label="Direct link to 1.3 Topic configuration API" title="Direct link to 1.3 Topic configuration API"></a></h3><h4 class="anchor anchorWithStickyNavbar_LWe7" id="131-admin_add_new_topic_record">1.3.1 <code>admin_add_new_topic_record</code><a href="#131-admin_add_new_topic_record" class="hash-link" aria-label="Direct link to 131-admin_add_new_topic_record" title="Direct link to 131-admin_add_new_topic_record"></a></h4><p>Add topic related configuration.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>brokerId</td><td>yes</td><td>the id of the broker, its default value is 0. If brokerId is not zero, it ignores brokerIp field</td><td>String</td></tr><tr><td>deleteWhen</td><td>no</td><td>the default deleting time of the topic data. The format should like cronjob form <code>0 0 6, 18 * * ?</code></td><td>String</td></tr><tr><td>deletePolicy</td><td>no</td><td>the default policy for deleting, the default policy is "delete, 168"</td><td>String</td></tr><tr><td>numPartitions</td><td>no</td><td>the default partition number of a default topic on the broker. Default 1</td><td>Int</td></tr><tr><td>unflushThreshold</td><td>no</td><td>the maximum message number which allows in memory. It has to be flushed to disk if the number exceed this value. Default 1000</td><td>Int</td></tr><tr><td>numTopicStores</td><td>no</td><td>the number of data block and partition group allowed to create, default 1. If it is larger than 1, the partition number and topic number should be mapping with this value</td><td>Int</td></tr><tr><td>unflushInterval</td><td>no</td><td>the maximum interval for unflush, default 1000ms</td><td>Int</td></tr><tr><td>memCacheMsgCntInK</td><td>no</td><td>the max cached message package, default is 10, the unit is K</td><td>Int</td></tr><tr><td>memCacheMsgSizeInMB</td><td>no</td><td>the max cache message size in MB, default 3</td><td>Int</td></tr><tr><td>memCacheFlushIntvl</td><td>no</td><td>the max unflush interval in ms, default 20000</td><td>Int</td></tr><tr><td>brokerTLSPort</td><td>no</td><td>the port of TLS of the broker, it has no default value</td><td>Int</td></tr><tr><td>acceptPublish</td><td>no</td><td>whether the broker accept publish, default true</td><td>Boolean</td></tr><tr><td>acceptSubscribe</td><td>no</td><td>whether the broker accept subscribe, default true</td><td>Boolean</td></tr><tr><td>createUser</td><td>yes</td><td>the create user</td><td>String</td></tr><tr><td>createDate</td><td>yes</td><td>the create date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="132-admin_query_topic_info">1.3.2 <code>admin_query_topic_info</code><a href="#132-admin_query_topic_info" class="hash-link" aria-label="Direct link to 132-admin_query_topic_info" title="Direct link to 132-admin_query_topic_info"></a></h4><p>Query specific topic record info.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>topicStatusId</td><td>no</td><td>the status of topic record, 0-normal record, 1-already soft delete, 2-already hard delete, default 0</td><td>int</td></tr><tr><td>brokerId</td><td>yes</td><td>the id of the broker, its default value is 0. If brokerId is not zero, it ignores brokerIp field</td><td>String</td></tr><tr><td>deleteWhen</td><td>no</td><td>the default deleting time of the topic data. The format should like cronjob form <code>0 0 6, 18 * * ?</code></td><td>String</td></tr><tr><td>deletePolicy</td><td>no</td><td>the default policy for deleting, the default policy is "delete, 168"</td><td>String</td></tr><tr><td>numPartitions</td><td>no</td><td>the default partition number of a default topic on the broker. Default 3</td><td>Int</td></tr><tr><td>unflushThreshold</td><td>no</td><td>the maximum message number which allows in memory. It has to be flushed to disk if the number exceed this value. Default 1000</td><td>Int</td></tr><tr><td>numTopicStores</td><td>no</td><td>the number of data block and partition group allowed to create, default 1. If it is larger than 1, the partition number and topic number should be mapping with this value</td><td>Int</td></tr><tr><td>unflushInterval</td><td>no</td><td>the maximum interval for unflush, default 1000ms</td><td>Int</td></tr><tr><td>memCacheMsgCntInK</td><td>no</td><td>the max cached message package, default is 10, the unit is K</td><td>Int</td></tr><tr><td>memCacheMsgSizeInMB</td><td>no</td><td>the max cache message size in MB, default 3</td><td>Int</td></tr><tr><td>memCacheFlushIntvl</td><td>no</td><td>the max unflush interval in ms, default 20000</td><td>Int</td></tr><tr><td>brokerTLSPort</td><td>no</td><td>the port of TLS of the broker, it has no default value</td><td>Int</td></tr><tr><td>acceptPublish</td><td>no</td><td>whether the broker accept publish, default true</td><td>Boolean</td></tr><tr><td>acceptSubscribe</td><td>no</td><td>whether the broker accept subscribe, default true</td><td>Boolean</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="133-admin_modify_topic_info">1.3.3 <code>admin_modify_topic_info</code><a href="#133-admin_modify_topic_info" class="hash-link" aria-label="Direct link to 133-admin_modify_topic_info" title="Direct link to 133-admin_modify_topic_info"></a></h4><p>Modify specific topic record info.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>topicStatusId</td><td>no</td><td>the status of topic record, 0-normal record, 1-already soft delete, 2-already hard delete, default 0</td><td>int</td></tr><tr><td>brokerId</td><td>yes</td><td>the id of the broker, its default value is 0. If brokerId is not zero, it ignores brokerIp field</td><td>String</td></tr><tr><td>deleteWhen</td><td>no</td><td>the default deleting time of the topic data. The format should like cronjob form <code>0 0 6, 18 * * ?</code></td><td>String</td></tr><tr><td>deletePolicy</td><td>no</td><td>the default policy for deleting, the default policy is "delete, 168"</td><td>String</td></tr><tr><td>numPartitions</td><td>no</td><td>the default partition number of a default topic on the broker. Default 3</td><td>Int</td></tr><tr><td>unflushThreshold</td><td>no</td><td>the maximum message number which allows in memory. It has to be flushed to disk if the number exceed this value. Default 1000</td><td>Int</td></tr><tr><td>numTopicStores</td><td>no</td><td>the number of data block and partition group allowed to create, default 1. If it is larger than 1, the partition number and topic number should be mapping with this value</td><td>Int</td></tr><tr><td>unflushInterval</td><td>no</td><td>the maximum interval for unflush, default 1000ms</td><td>Int</td></tr><tr><td>memCacheMsgCntInK</td><td>no</td><td>the max cached message package, default is 10, the unit is K</td><td>Int</td></tr><tr><td>memCacheMsgSizeInMB</td><td>no</td><td>the max cache message size in MB, default 3</td><td>Int</td></tr><tr><td>memCacheFlushIntvl</td><td>no</td><td>the max unflush interval in ms, default 20000</td><td>Int</td></tr><tr><td>brokerTLSPort</td><td>no</td><td>the port of TLS of the broker, it has no default value</td><td>Int</td></tr><tr><td>acceptPublish</td><td>no</td><td>whether the broker accept publish, default true</td><td>Boolean</td></tr><tr><td>acceptSubscribe</td><td>no</td><td>whether the broker accept subscribe, default true</td><td>Boolean</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>yes</td><td>the modification date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="134-admin_delete_topic_info">1.3.4 <code>admin_delete_topic_info</code><a href="#134-admin_delete_topic_info" class="hash-link" aria-label="Direct link to 134-admin_delete_topic_info" title="Direct link to 134-admin_delete_topic_info"></a></h4><p>Delete specific topic record info softly.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>brokerId</td><td>yes</td><td>the id of the broker, its default value is 0. If brokerId is not zero, it ignores brokerIp field</td><td>String</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>yes</td><td>the modification date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="134-admin_redo_deleted_topic_info">1.3.4 <code>admin_redo_deleted_topic_info</code><a href="#134-admin_redo_deleted_topic_info" class="hash-link" aria-label="Direct link to 134-admin_redo_deleted_topic_info" title="Direct link to 134-admin_redo_deleted_topic_info"></a></h4><p>Redo the Deleted specific topic record info.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>brokerId</td><td>yes</td><td>the id of the broker, its default value is 0. If brokerId is not zero, it ignores brokerIp field</td><td>String</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>yes</td><td>the modification date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="135-admin_remove_topic_info">1.3.5 <code>admin_remove_topic_info</code><a href="#135-admin_remove_topic_info" class="hash-link" aria-label="Direct link to 135-admin_remove_topic_info" title="Direct link to 135-admin_remove_topic_info"></a></h4><p>Delete specific topic record info hardly.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>brokerId</td><td>yes</td><td>the id of the broker, its default value is 0. If brokerId is not zero, it ignores brokerIp field</td><td>String</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>yes</td><td>the modification date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h4 class="anchor anchorWithStickyNavbar_LWe7" id="136-admin_query_broker_topic_config_info">1.3.6 <code>admin_query_broker_topic_config_info</code><a href="#136-admin_query_broker_topic_config_info" class="hash-link" aria-label="Direct link to 136-admin_query_broker_topic_config_info" title="Direct link to 136-admin_query_broker_topic_config_info"></a></h4><p>Query the topic configuration info of the broker in current cluster.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="2-master-consumer-permission-operation-api">2 Master consumer permission operation API<a href="#2-master-consumer-permission-operation-api" class="hash-link" aria-label="Direct link to 2 Master consumer permission operation API" title="Direct link to 2 Master consumer permission operation API"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="21-admin_set_topic_info_authorize_control">2.1 <code>admin_set_topic_info_authorize_control</code><a href="#21-admin_set_topic_info_authorize_control" class="hash-link" aria-label="Direct link to 21-admin_set_topic_info_authorize_control" title="Direct link to 21-admin_set_topic_info_authorize_control"></a></h3><p>Enable or disable the authorization control feature of the topic. If the consumer group is not authorized, the register request will be denied. |
| If the topic's authorization group is empty, the topic will fail.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>no</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>isEnable</td><td>no</td><td>whether the authorization control is enable, default false</td><td>Boolean</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="22-admin_delete_topic_info_authorize_control">2.2 <code>admin_delete_topic_info_authorize_control</code><a href="#22-admin_delete_topic_info_authorize_control" class="hash-link" aria-label="Direct link to 22-admin_delete_topic_info_authorize_control" title="Direct link to 22-admin_delete_topic_info_authorize_control"></a></h3><p>Delete the authorization control feature of the topic. The content of the authorized consumer group list will be delete as well.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="23-admin_query_topic_info_authorize_control">2.3 <code>admin_query_topic_info_authorize_control</code><a href="#23-admin_query_topic_info_authorize_control" class="hash-link" aria-label="Direct link to 23-admin_query_topic_info_authorize_control" title="Direct link to 23-admin_query_topic_info_authorize_control"></a></h3><p>Query the authorization control feature of the topic.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="24-admin_add_authorized_consumergroup_info">2.4 <code>admin_add_authorized_consumergroup_info</code><a href="#24-admin_add_authorized_consumergroup_info" class="hash-link" aria-label="Direct link to 24-admin_add_authorized_consumergroup_info" title="Direct link to 24-admin_add_authorized_consumergroup_info"></a></h3><p>Add new authorized consumer group record of the topic. The server will deny the registration from the consumer group which is not exist in |
| topic's authorized consumer group.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>groupName</td><td>yes</td><td>the group name to be added</td><td>String</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>no</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="25-admin_query_allowed_consumer_group_info">2.5 <code>admin_query_allowed_consumer_group_info</code><a href="#25-admin_query_allowed_consumer_group_info" class="hash-link" aria-label="Direct link to 25-admin_query_allowed_consumer_group_info" title="Direct link to 25-admin_query_allowed_consumer_group_info"></a></h3><p>Query the authorized consumer group record of the topic. </p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>groupName</td><td>yes</td><td>the group name to be added</td><td>String</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="26-admin_delete_allowed_consumer_group_info">2.6 <code>admin_delete_allowed_consumer_group_info</code><a href="#26-admin_delete_allowed_consumer_group_info" class="hash-link" aria-label="Direct link to 26-admin_delete_allowed_consumer_group_info" title="Direct link to 26-admin_delete_allowed_consumer_group_info"></a></h3><p>Delete the authorized consumer group record of the topic. </p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>groupName</td><td>yes</td><td>the group name to be added</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="27admin_batch_add_topic_authorize_control">2.7<code>admin_batch_add_topic_authorize_control</code><a href="#27admin_batch_add_topic_authorize_control" class="hash-link" aria-label="Direct link to 27admin_batch_add_topic_authorize_control" title="Direct link to 27admin_batch_add_topic_authorize_control"></a></h3><p>Add the authorized consumer group of the topic record in batch mode.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicJsonSet</td><td>yes</td><td>the topic names in JSON format</td><td>List</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>no</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="28-admin_batch_add_authorized_consumergroup_info">2.8 <code>admin_batch_add_authorized_consumergroup_info</code><a href="#28-admin_batch_add_authorized_consumergroup_info" class="hash-link" aria-label="Direct link to 28-admin_batch_add_authorized_consumergroup_info" title="Direct link to 28-admin_batch_add_authorized_consumergroup_info"></a></h3><p>Add the authorized consumer group record in batch mode.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>groupNameJsonSet</td><td>yes</td><td>the group names in JSON format</td><td>List</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>no</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="29-admin_add_black_consumergroup_info">2.9 <code>admin_add_black_consumergroup_info</code><a href="#29-admin_add_black_consumergroup_info" class="hash-link" aria-label="Direct link to 29-admin_add_black_consumergroup_info" title="Direct link to 29-admin_add_black_consumergroup_info"></a></h3><p>Add consumer group into the black list of the topic. The registered consumer on the group cannot consume topic later as well as unregistered one.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>List</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>List</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>no</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="210-admin_query_black_consumergroup_info">2.10 <code>admin_query_black_consumergroup_info</code><a href="#210-admin_query_black_consumergroup_info" class="hash-link" aria-label="Direct link to 210-admin_query_black_consumergroup_info" title="Direct link to 210-admin_query_black_consumergroup_info"></a></h3><p>Query the black list of the topic. </p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>List</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>List</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="211-admin_delete_black_consumergroup_info">2.11 <code>admin_delete_black_consumergroup_info</code><a href="#211-admin_delete_black_consumergroup_info" class="hash-link" aria-label="Direct link to 211-admin_delete_black_consumergroup_info" title="Direct link to 211-admin_delete_black_consumergroup_info"></a></h3><p>Delete the black list of the topic. </p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>List</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>List</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="212-admin_add_group_filtercond_info">2.12 <code>admin_add_group_filtercond_info</code><a href="#212-admin_add_group_filtercond_info" class="hash-link" aria-label="Direct link to 212-admin_add_group_filtercond_info" title="Direct link to 212-admin_add_group_filtercond_info"></a></h3><p>Add condition of consuming filter for the consumer group </p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>List</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>List</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr><tr><td>condStatus</td><td>no</td><td>the condition status, 0: disable, 1:enable full authorization, 2:enable and limit consuming</td><td>Int</td></tr><tr><td>filterConds</td><td>no</td><td>the filter conditions, the max length is 256</td><td>String</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>no</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="213-admin_mod_group_filtercond_info">2.13 <code>admin_mod_group_filtercond_info</code><a href="#213-admin_mod_group_filtercond_info" class="hash-link" aria-label="Direct link to 213-admin_mod_group_filtercond_info" title="Direct link to 213-admin_mod_group_filtercond_info"></a></h3><p>Modify the condition of consuming filter for the consumer group </p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>List</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>List</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr><tr><td>condStatus</td><td>no</td><td>the condition status, 0: disable, 1:enable full authorization, 2:enable and limit consuming</td><td>Int</td></tr><tr><td>filterConds</td><td>no</td><td>the filter conditions, the max length is 256</td><td>String</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>no</td><td>the modification date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="214-admin_del_group_filtercond_info">2.14 <code>admin_del_group_filtercond_info</code><a href="#214-admin_del_group_filtercond_info" class="hash-link" aria-label="Direct link to 214-admin_del_group_filtercond_info" title="Direct link to 214-admin_del_group_filtercond_info"></a></h3><p>Delete the condition of consuming filter for the consumer group </p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>List</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>List</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="215-admin_query_group_filtercond_info">2.15 <code>admin_query_group_filtercond_info</code><a href="#215-admin_query_group_filtercond_info" class="hash-link" aria-label="Direct link to 215-admin_query_group_filtercond_info" title="Direct link to 215-admin_query_group_filtercond_info"></a></h3><p>Query the condition of consuming filter for the consumer group </p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>List</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>List</td></tr><tr><td>condStatus</td><td>no</td><td>the condition status, 0: disable, 1:enable full authorization, 2:enable and limit consuming</td><td>Int</td></tr><tr><td>filterConds</td><td>no</td><td>the filter conditions, the max length is 256</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="216-admin_rebalance_group_allocate">2.16 <code>admin_rebalance_group_allocate</code><a href="#216-admin_rebalance_group_allocate" class="hash-link" aria-label="Direct link to 216-admin_rebalance_group_allocate" title="Direct link to 216-admin_rebalance_group_allocate"></a></h3><p>Adjust consuming partition of the specific consumer in consumer group. This includes: \</p><ol><li>release current consuming partition and retrieve new consuming partition.</li><li>release current consuming partition and stop consuming for a while, then retrieve new consuming partition.</li></ol><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr><tr><td>consumerId</td><td>yes</td><td>the consumer id</td><td>List</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>List</td></tr><tr><td>reJoinWait</td><td>no</td><td>the time in ms wait for re-consuming, the default value is 0 which means re-consuming immediately</td><td>Int</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>yes</td><td>the modification date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="217-admin_set_def_flow_control_rule">2.17 <code>admin_set_def_flow_control_rule</code><a href="#217-admin_set_def_flow_control_rule" class="hash-link" aria-label="Direct link to 217-admin_set_def_flow_control_rule" title="Direct link to 217-admin_set_def_flow_control_rule"></a></h3><p>Set default flow control rule. It is effective for all consumer group. It worth to note that the priority is lower than the setting in consumer group.</p><p>The flow control info is described in JSON format, for example: </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"type"</span><span class="token operator">:</span><span class="token number">0</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"rule"</span><span class="token operator">:</span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"start"</span><span class="token operator">:</span><span class="token string" style="color:rgb(255, 121, 198)">"08:00"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"end"</span><span class="token operator">:</span><span class="token string" style="color:rgb(255, 121, 198)">"17:59"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"dltInM"</span><span class="token operator">:</span><span class="token number">1024</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"limitInM"</span><span class="token operator">:</span><span class="token number">20</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"freqInMs"</span><span class="token operator">:</span><span class="token number">1000</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"start"</span><span class="token operator">:</span><span class="token string" style="color:rgb(255, 121, 198)">"18:00"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"end"</span><span class="token operator">:</span><span class="token string" style="color:rgb(255, 121, 198)">"22:00"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"dltInM"</span><span class="token operator">:</span><span class="token number">1024</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"limitInM"</span><span class="token operator">:</span><span class="token number">20</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"freqInMs"</span><span class="token operator">:</span><span class="token number">5000</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"type"</span><span class="token operator">:</span><span class="token number">2</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"rule"</span><span class="token operator">:</span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"start"</span><span class="token operator">:</span><span class="token string" style="color:rgb(255, 121, 198)">"18:00"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"end"</span><span class="token operator">:</span><span class="token string" style="color:rgb(255, 121, 198)">"23:59"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"dltStInM"</span><span class="token operator">:</span><span class="token number">20480</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"dltEdInMM"</span><span class="token operator">:</span><span class="token number">2048</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"type"</span><span class="token operator">:</span><span class="token number">1</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"rule"</span><span class="token operator">:</span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"zeroCnt"</span><span class="token operator">:</span><span class="token number">3</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"freqInMs"</span><span class="token operator">:</span><span class="token number">300</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"zeroCnt"</span><span class="token operator">:</span><span class="token number">8</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"freqInMs"</span><span class="token operator">:</span><span class="token number">1000</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"type"</span><span class="token operator">:</span><span class="token number">3</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"rule"</span><span class="token operator">:</span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token property">"normFreqInMs"</span><span class="token operator">:</span><span class="token number">0</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"filterFreqInMs"</span><span class="token operator">:</span><span class="token number">100</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token property">"minDataFilterFreqInMs"</span><span class="token operator">:</span><span class="token number">400</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The <code>type</code> has four values <!-- -->[0, 1, 3]<!-- -->. 0: flow control, 1: frequency control, 3: filter consumer frequency control,<br> |
| <code>[start, end]</code> is an inclusive range of time, <code>dltInM</code> is the consuming delta in MB, <code>limitInM</code> is the flow control each minute, <br> |
| <code>freqInMs</code> is the interval for sending request after exceeding the flow or freq limit, <code>zeroCnt</code> is the count of how many times occurs zero data, <br> |
| <code>normFreqInMs</code> is the interval of sequential pulling, <code>filterFreqInMs</code> is the interval of pulling filtered request.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>flowCtrlInfo</td><td>yes</td><td>the flow control info in JSON format</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr><tr><td>consumerId</td><td>yes</td><td>the consumer id</td><td>List</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>List</td></tr><tr><td>reJoinWait</td><td>no</td><td>the time in ms wait for re-consuming, the default value is 0 which means re-consuming immediately</td><td>Int</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>yes</td><td>the modification date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="218-admin_upd_def_flow_control_rule">2.18 <code>admin_upd_def_flow_control_rule</code><a href="#218-admin_upd_def_flow_control_rule" class="hash-link" aria-label="Direct link to 218-admin_upd_def_flow_control_rule" title="Direct link to 218-admin_upd_def_flow_control_rule"></a></h3><p>Update the default flow control rule.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr><tr><td>StatusId</td><td>no</td><td>the strategy status Id, default 0</td><td>int</td></tr><tr><td>qryPriorityId</td><td>no</td><td>the consuming priority Id. It is a composed field <code>A0B</code> with default value 301, <br>the value of A,B is <!-- -->[1, 2, 3]<!-- --> which means file, backup memory, and main memory respectively</td><td>int</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>flowCtrlInfo</td><td>yes</td><td>the flow control info in JSON format</td><td>String</td></tr><tr><td>createDate</td><td>yes</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="219-admin_query_def_flow_control_rule">2.19 <code>admin_query_def_flow_control_rule</code><a href="#219-admin_query_def_flow_control_rule" class="hash-link" aria-label="Direct link to 219-admin_query_def_flow_control_rule" title="Direct link to 219-admin_query_def_flow_control_rule"></a></h3><p>Query the default flow control rule.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>StatusId</td><td>no</td><td>the strategy status Id, default 0</td><td>int</td></tr><tr><td>qryPriorityId</td><td>no</td><td>the consuming priority Id. It is a composed field <code>A0B</code> with default value 301,<br> the value of A,B is <!-- -->[1, 2, 3]<!-- --> which means file, backup memory, and main memory respectively</td><td>int</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="220-admin_set_group_flow_control_rule">2.20 <code>admin_set_group_flow_control_rule</code><a href="#220-admin_set_group_flow_control_rule" class="hash-link" aria-label="Direct link to 220-admin_set_group_flow_control_rule" title="Direct link to 220-admin_set_group_flow_control_rule"></a></h3><p>Set the group flow control rule.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>flowCtrlInfo</td><td>yes</td><td>the flow control info in JSON format</td><td>String</td></tr><tr><td>groupName</td><td>yes</td><td>the group name to set flow control rule</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr><tr><td>StatusId</td><td>no</td><td>the strategy status Id, default 0</td><td>int</td></tr><tr><td>qryPriorityId</td><td>no</td><td>the consuming priority Id. It is a composed field <code>A0B</code> with default value 301,<br> the value of A,B is <!-- -->[1, 2, 3]<!-- --> which means file, backup memory, and main memory respectively</td><td>int</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>yes</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="221-admin_upd_group_flow_control_rule">2.21 <code>admin_upd_group_flow_control_rule</code><a href="#221-admin_upd_group_flow_control_rule" class="hash-link" aria-label="Direct link to 221-admin_upd_group_flow_control_rule" title="Direct link to 221-admin_upd_group_flow_control_rule"></a></h3><p>Update the group flow control rule.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>flowCtrlInfo</td><td>yes</td><td>the flow control info in JSON format</td><td>String</td></tr><tr><td>groupName</td><td>yes</td><td>the group name to set flow control rule</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr><tr><td>StatusId</td><td>no</td><td>the strategy status Id, default 0</td><td>int</td></tr><tr><td>qryPriorityId</td><td>no</td><td>the consuming priority Id. It is a composed field <code>A0B</code> with default value 301,<br> the value of A,B is <!-- -->[1, 2, 3]<!-- --> which means file, backup memory, and main memory respectively</td><td>int</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>yes</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="222-admin_rmv_group_flow_control_rule">2.22 <code>admin_rmv_group_flow_control_rule</code><a href="#222-admin_rmv_group_flow_control_rule" class="hash-link" aria-label="Direct link to 222-admin_rmv_group_flow_control_rule" title="Direct link to 222-admin_rmv_group_flow_control_rule"></a></h3><p>Remove the group flow control rule.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>groupName</td><td>yes</td><td>the group name to set flow control rule</td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="223-admin_query_group_flow_control_rule">2.23 <code>admin_query_group_flow_control_rule</code><a href="#223-admin_query_group_flow_control_rule" class="hash-link" aria-label="Direct link to 223-admin_query_group_flow_control_rule" title="Direct link to 223-admin_query_group_flow_control_rule"></a></h3><p>Remove the group flow control rule.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>groupName</td><td>yes</td><td>the group name to set flow control rule</td><td>String</td></tr><tr><td>StatusId</td><td>no</td><td>the strategy status Id, default 0</td><td>int</td></tr><tr><td>qryPriorityId</td><td>no</td><td>the consuming priority Id. It is a composed field <code>A0B</code> with default value 301, <br>the value of A,B is <!-- -->[1, 2, 3]<!-- --> which means file, backup memory, and main memory respectively</td><td>int</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="224-admin_add_consume_group_setting">2.24 <code>admin_add_consume_group_setting</code><a href="#224-admin_add_consume_group_setting" class="hash-link" aria-label="Direct link to 224-admin_add_consume_group_setting" title="Direct link to 224-admin_add_consume_group_setting"></a></h3><p>Set whether to allow consume group to consume via specific offset, and the ratio of broker and client when starting the consume group.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>groupName</td><td>yes</td><td>the group name to set flow control rule</td><td>String</td></tr><tr><td>enableBind</td><td>no</td><td>whether to bind consuming permission, default value 0 means disable</td><td>int</td></tr><tr><td>allowedBClientRate</td><td>no</td><td>the ratio of the number of the consuming target's broker against the number of client in consuming group</td><td>int</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr><tr><td>createDate</td><td>yes</td><td>the creating date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="225-admin_query_consume_group_setting">2.25 <code>admin_query_consume_group_setting</code><a href="#225-admin_query_consume_group_setting" class="hash-link" aria-label="Direct link to 225-admin_query_consume_group_setting" title="Direct link to 225-admin_query_consume_group_setting"></a></h3><p>Query the consume group setting to check whether to allow consume group to consume via specific offset, and the ratio of broker and client when starting the consume group.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>groupName</td><td>yes</td><td>the group name to set flow control rule</td><td>String</td></tr><tr><td>enableBind</td><td>no</td><td>whether to bind consuming permission, default value 0 means disable</td><td>int</td></tr><tr><td>allowedBClientRate</td><td>no</td><td>the ratio of the number of the consuming target's broker against the number of client in consuming group</td><td>int</td></tr><tr><td>createUser</td><td>yes</td><td>the creator</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="226-admin_upd_consume_group_setting">2.26 <code>admin_upd_consume_group_setting</code><a href="#226-admin_upd_consume_group_setting" class="hash-link" aria-label="Direct link to 226-admin_upd_consume_group_setting" title="Direct link to 226-admin_upd_consume_group_setting"></a></h3><p>Update the consume group setting for whether to allow consume group to consume via specific offset, and the ratio of broker and client when starting the consume group.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>groupName</td><td>yes</td><td>the group name to set flow control rule</td><td>String</td></tr><tr><td>enableBind</td><td>no</td><td>whether to bind consuming permission, default value 0 means disable</td><td>int</td></tr><tr><td>allowedBClientRate</td><td>no</td><td>the ratio of the number of the consuming target's broker against the number of client in consuming group</td><td>int</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>yes</td><td>the modifying date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="227-admin_del_consume_group_setting">2.27 <code>admin_del_consume_group_setting</code><a href="#227-admin_del_consume_group_setting" class="hash-link" aria-label="Direct link to 227-admin_del_consume_group_setting" title="Direct link to 227-admin_del_consume_group_setting"></a></h3><p>Delete the consume group setting for whether to allow consume group to consume via specific offset, and the ratio of broker and client when starting the consume group.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>groupName</td><td>yes</td><td>the group name to set flow control rule</td><td>String</td></tr><tr><td>modifyUser</td><td>yes</td><td>the modifier</td><td>String</td></tr><tr><td>modifyDate</td><td>yes</td><td>the modifying date in format <code>yyyyMMddHHmmss</code></td><td>String</td></tr><tr><td>confModAuthToken</td><td>yes</td><td>the authorized key for configuration update</td><td>String</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="3-master-subscriber-relation-api">3 Master subscriber relation API<a href="#3-master-subscriber-relation-api" class="hash-link" aria-label="Direct link to 3 Master subscriber relation API" title="Direct link to 3 Master subscriber relation API"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="31-query-consumer-group-subscription-information">3.1 Query consumer group subscription information<a href="#31-query-consumer-group-subscription-information" class="hash-link" aria-label="Direct link to 3.1 Query consumer group subscription information" title="Direct link to 3.1 Query consumer group subscription information"></a></h3><p>Url <code>http://127.0.0.1:8080/webapi.htm?type=op_query&method=admin_query_sub_info&topicName=test&consumeGroup=xxx</code></p><p>response:</p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"errCode"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">0</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"errMsg"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">"Ok"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"count"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">263</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"data"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"consumeGroup"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">""</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"topicSet"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token string" style="color:rgb(255, 121, 198)">"a"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">"b"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"consumerNum"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">33</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token plain"> </span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="32-query-consumer-group-detailed-subscription-information">3.2 Query consumer group detailed subscription information<a href="#32-query-consumer-group-detailed-subscription-information" class="hash-link" aria-label="Direct link to 3.2 Query consumer group detailed subscription information" title="Direct link to 3.2 Query consumer group detailed subscription information"></a></h3><p>Url <code>http://127.0.0.1:8080/webapi.htm?type=op_query&method=admin_query_consume_group_detail&consumeGroup=test_25</code></p><p>response:</p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"errCode"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">0</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"errMsg"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">"Ok"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"count"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">263</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"topicSet"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token string" style="color:rgb(255, 121, 198)">"a"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">"b"</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"consumeGroup"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">""</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"data"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"consumerId"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">""</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"parCount"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">1</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"parInfo"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">[</span><span class="token punctuation" style="color:rgb(248, 248, 242)">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"brokerAddr"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">""</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"topic"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token string" style="color:rgb(255, 121, 198)">""</span><span class="token punctuation" style="color:rgb(248, 248, 242)">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token property">"partId"</span><span class="token operator">:</span><span class="token plain"> </span><span class="token number">2</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token plain"> </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token punctuation" style="color:rgb(248, 248, 242)">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token punctuation" style="color:rgb(248, 248, 242)">}</span><span class="token plain"> </span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="4-broker-operation-api">4 Broker operation API<a href="#4-broker-operation-api" class="hash-link" aria-label="Direct link to 4 Broker operation API" title="Direct link to 4 Broker operation API"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="41-admin_snapshot_message">4.1 <code>admin_snapshot_message</code><a href="#41-admin_snapshot_message" class="hash-link" aria-label="Direct link to 41-admin_snapshot_message" title="Direct link to 41-admin_snapshot_message"></a></h3><p>Check whether it is transferring data under current broker's topic, and what is the content.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>msgCount</td><td>no</td><td>the max number of message to extract</td><td>int</td></tr><tr><td>partitionId</td><td>yes</td><td>the partition ID which must exists</td><td>int</td></tr><tr><td>filterConds</td><td>yes</td><td>the streamId value for filtering</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="42-admin_manual_set_current_offset">4.2 <code>admin_manual_set_current_offset</code><a href="#42-admin_manual_set_current_offset" class="hash-link" aria-label="Direct link to 42-admin_manual_set_current_offset" title="Direct link to 42-admin_manual_set_current_offset"></a></h3><p>Modify the offset value of consuming group under current broker. The new value will be persisted to ZK.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>String</td></tr><tr><td>modifyUser</td><td>no</td><td>the user who modify the value</td><td>String</td></tr><tr><td>partitionId</td><td>yes</td><td>the partition ID which must exists</td><td>int</td></tr><tr><td>manualOffset</td><td>yes</td><td>the offset to be modified, it must be a valid value</td><td>long</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="43-admin_query_group_offset">4.3 <code>admin_query_group_offset</code><a href="#43-admin_query_group_offset" class="hash-link" aria-label="Direct link to 43-admin_query_group_offset" title="Direct link to 43-admin_query_group_offset"></a></h3><p>Query the offset of consuming group under current broker.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>groupName</td><td>yes</td><td>the group name</td><td>String</td></tr><tr><td>partitionId</td><td>yes</td><td>the partition ID which must exists</td><td>int</td></tr><tr><td>requireRealOffset</td><td>no</td><td>whether to check real offset on ZK, default false</td><td>Boolean</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="44-admin_query_broker_all_consumer_info">4.4 <code>admin_query_broker_all_consumer_info</code><a href="#44-admin_query_broker_all_consumer_info" class="hash-link" aria-label="Direct link to 44-admin_query_broker_all_consumer_info" title="Direct link to 44-admin_query_broker_all_consumer_info"></a></h3><p>Query consumer info of the specific consume group on the broker.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>groupName</td><td>yes</td><td>the group name</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="45-admin_query_broker_all_store_info">4.5 <code>admin_query_broker_all_store_info</code><a href="#45-admin_query_broker_all_store_info" class="hash-link" aria-label="Direct link to 45-admin_query_broker_all_store_info" title="Direct link to 45-admin_query_broker_all_store_info"></a></h3><p>Query store info of the specific topic on the broker.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="46-admin_query_broker_memstore_info">4.6 <code>admin_query_broker_memstore_info</code><a href="#46-admin_query_broker_memstore_info" class="hash-link" aria-label="Direct link to 46-admin_query_broker_memstore_info" title="Direct link to 46-admin_query_broker_memstore_info"></a></h3><p>Query memory store info of the specific topic on the broker.</p><p><strong>Request</strong></p><table><thead><tr><th>name</th><th>must</th><th>description</th><th>type</th></tr></thead><tbody><tr><td>topicName</td><td>yes</td><td>the topic name</td><td>String</td></tr><tr><td>needRefresh</td><td>no</td><td>whether it needs to refresh, default false</td><td>Boolean</td></tr></tbody></table><p>More API see:</p><a target="_blank" href="/appendixfiles/http_access_api_definition_cn.xls">TubeMQ HTTP API</a><hr><a href="#top">Back to top</a></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/inlong-website/edit/master/versioned_docs/version-1.6.0/modules/tubemq/http_access_api.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" 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_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.6.0/modules/tubemq/error_code"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Error Code</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.6.0/modules/tubemq/tubemq_metrics"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">TubeMQ Metrics</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#1-master-metadata-configuration-api" class="table-of-contents__link toc-highlight">1 Master metadata configuration API</a><ul><li><a href="#11-cluster-management-api" class="table-of-contents__link toc-highlight">1.1 Cluster management API</a></li><li><a href="#12-broker-node-configuration-api" class="table-of-contents__link toc-highlight">1.2 Broker node configuration API</a></li><li><a href="#13-topic-configuration-api" class="table-of-contents__link toc-highlight">1.3 Topic configuration API</a></li></ul></li><li><a href="#2-master-consumer-permission-operation-api" class="table-of-contents__link toc-highlight">2 Master consumer permission operation API</a><ul><li><a href="#21-admin_set_topic_info_authorize_control" class="table-of-contents__link toc-highlight">2.1 <code>admin_set_topic_info_authorize_control</code></a></li><li><a href="#22-admin_delete_topic_info_authorize_control" class="table-of-contents__link toc-highlight">2.2 <code>admin_delete_topic_info_authorize_control</code></a></li><li><a href="#23-admin_query_topic_info_authorize_control" class="table-of-contents__link toc-highlight">2.3 <code>admin_query_topic_info_authorize_control</code></a></li><li><a href="#24-admin_add_authorized_consumergroup_info" class="table-of-contents__link toc-highlight">2.4 <code>admin_add_authorized_consumergroup_info</code></a></li><li><a href="#25-admin_query_allowed_consumer_group_info" class="table-of-contents__link toc-highlight">2.5 <code>admin_query_allowed_consumer_group_info</code></a></li><li><a href="#26-admin_delete_allowed_consumer_group_info" class="table-of-contents__link toc-highlight">2.6 <code>admin_delete_allowed_consumer_group_info</code></a></li><li><a href="#27admin_batch_add_topic_authorize_control" class="table-of-contents__link toc-highlight">2.7<code>admin_batch_add_topic_authorize_control</code></a></li><li><a href="#28-admin_batch_add_authorized_consumergroup_info" class="table-of-contents__link toc-highlight">2.8 <code>admin_batch_add_authorized_consumergroup_info</code></a></li><li><a href="#29-admin_add_black_consumergroup_info" class="table-of-contents__link toc-highlight">2.9 <code>admin_add_black_consumergroup_info</code></a></li><li><a href="#210-admin_query_black_consumergroup_info" class="table-of-contents__link toc-highlight">2.10 <code>admin_query_black_consumergroup_info</code></a></li><li><a href="#211-admin_delete_black_consumergroup_info" class="table-of-contents__link toc-highlight">2.11 <code>admin_delete_black_consumergroup_info</code></a></li><li><a href="#212-admin_add_group_filtercond_info" class="table-of-contents__link toc-highlight">2.12 <code>admin_add_group_filtercond_info</code></a></li><li><a href="#213-admin_mod_group_filtercond_info" class="table-of-contents__link toc-highlight">2.13 <code>admin_mod_group_filtercond_info</code></a></li><li><a href="#214-admin_del_group_filtercond_info" class="table-of-contents__link toc-highlight">2.14 <code>admin_del_group_filtercond_info</code></a></li><li><a href="#215-admin_query_group_filtercond_info" class="table-of-contents__link toc-highlight">2.15 <code>admin_query_group_filtercond_info</code></a></li><li><a href="#216-admin_rebalance_group_allocate" class="table-of-contents__link toc-highlight">2.16 <code>admin_rebalance_group_allocate</code></a></li><li><a href="#217-admin_set_def_flow_control_rule" class="table-of-contents__link toc-highlight">2.17 <code>admin_set_def_flow_control_rule</code></a></li><li><a href="#218-admin_upd_def_flow_control_rule" class="table-of-contents__link toc-highlight">2.18 <code>admin_upd_def_flow_control_rule</code></a></li><li><a href="#219-admin_query_def_flow_control_rule" class="table-of-contents__link toc-highlight">2.19 <code>admin_query_def_flow_control_rule</code></a></li><li><a href="#220-admin_set_group_flow_control_rule" class="table-of-contents__link toc-highlight">2.20 <code>admin_set_group_flow_control_rule</code></a></li><li><a href="#221-admin_upd_group_flow_control_rule" class="table-of-contents__link toc-highlight">2.21 <code>admin_upd_group_flow_control_rule</code></a></li><li><a href="#222-admin_rmv_group_flow_control_rule" class="table-of-contents__link toc-highlight">2.22 <code>admin_rmv_group_flow_control_rule</code></a></li><li><a href="#223-admin_query_group_flow_control_rule" class="table-of-contents__link toc-highlight">2.23 <code>admin_query_group_flow_control_rule</code></a></li><li><a href="#224-admin_add_consume_group_setting" class="table-of-contents__link toc-highlight">2.24 <code>admin_add_consume_group_setting</code></a></li><li><a href="#225-admin_query_consume_group_setting" class="table-of-contents__link toc-highlight">2.25 <code>admin_query_consume_group_setting</code></a></li><li><a href="#226-admin_upd_consume_group_setting" class="table-of-contents__link toc-highlight">2.26 <code>admin_upd_consume_group_setting</code></a></li><li><a href="#227-admin_del_consume_group_setting" class="table-of-contents__link toc-highlight">2.27 <code>admin_del_consume_group_setting</code></a></li></ul></li><li><a href="#3-master-subscriber-relation-api" class="table-of-contents__link toc-highlight">3 Master subscriber relation API</a><ul><li><a href="#31-query-consumer-group-subscription-information" class="table-of-contents__link toc-highlight">3.1 Query consumer group subscription information</a></li><li><a href="#32-query-consumer-group-detailed-subscription-information" class="table-of-contents__link toc-highlight">3.2 Query consumer group detailed subscription information</a></li></ul></li><li><a href="#4-broker-operation-api" class="table-of-contents__link toc-highlight">4 Broker operation API</a><ul><li><a href="#41-admin_snapshot_message" class="table-of-contents__link toc-highlight">4.1 <code>admin_snapshot_message</code></a></li><li><a href="#42-admin_manual_set_current_offset" class="table-of-contents__link toc-highlight">4.2 <code>admin_manual_set_current_offset</code></a></li><li><a href="#43-admin_query_group_offset" class="table-of-contents__link toc-highlight">4.3 <code>admin_query_group_offset</code></a></li><li><a href="#44-admin_query_broker_all_consumer_info" class="table-of-contents__link toc-highlight">4.4 <code>admin_query_broker_all_consumer_info</code></a></li><li><a href="#45-admin_query_broker_all_store_info" class="table-of-contents__link toc-highlight">4.5 <code>admin_query_broker_all_store_info</code></a></li><li><a href="#46-admin_query_broker_memstore_info" class="table-of-contents__link toc-highlight">4.6 <code>admin_query_broker_memstore_info</code></a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Events</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.apachecon.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">ApacheCon<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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></a></li><li class="footer__item"><a class="acevent" data-format="square" data-mode="dark" data-event="random"></a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://twitter.com/ApacheInlong" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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></a></li><li class="footer__item"><a href="https://inlong.apache.org/img/apache-inlong-wechat.jpg" target="_blank" rel="noopener noreferrer" class="footer__link-item">WeChat<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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></a></li><li class="footer__item"><a href="mailto:dev@inlong.apache.org" target="_blank" rel="noopener noreferrer" class="footer__link-item">Email</a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a href="https://github.com/apache/inlong" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><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></a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/img/asf_logo.svg" alt="Apache InLong" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/img/asf_logo.svg" alt="Apache InLong" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></div><div class="footer__copyright"><div style="font-family: Avenir-Medium;font-size: 14px;color: #999;"> |
| <div>Copyright © 2020-2024 The Apache Software Foundation. Licensed under the Apache License, Version 2.0.</div> |
| <div style="margin-top: 20px; padding-top: 20px; border-top: 1px solid #666;line-height: 20px;">The Apache Software Foundation Apache InLong, InLong, Apache, the Apache feather, and the Apache InLong project logo are either registered trademarks or trademarks of the Apache Software Foundation.</div> |
| </div></div></div></div></footer></div> |
| <script src="/assets/js/runtime~main.63c98e82.js"></script> |
| <script src="/assets/js/main.070aef2a.js"></script> |
| </body> |
| </html> |
