Google Git
Sign in
apache / inlong-website / refs/heads/asf-site / . / zh-CN / docs / next / modules / tubemq / commandline_tools / index.html
blob: ba4a296b86f0deb2c7157b685e65093069aef01e [file] [log] [blame]
<!doctype html>
<html lang="zh-CN" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-modules/tubemq/commandline_tools">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.3.1">
<title data-rh="true">命令行工具 | 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/zh-CN/docs/next/modules/tubemq/commandline_tools"><meta data-rh="true" name="docusaurus_locale" content="zh-CN"><meta data-rh="true" name="docsearch:language" content="zh-CN"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="命令行工具 | Apache InLong"><meta data-rh="true" name="description" content="总览"><meta data-rh="true" property="og:description" content="总览"><link data-rh="true" rel="icon" href="/zh-CN/img/logo.svg"><link data-rh="true" rel="canonical" href="https://inlong.apache.org/zh-CN/docs/next/modules/tubemq/commandline_tools"><link data-rh="true" rel="alternate" href="https://inlong.apache.org/docs/next/modules/tubemq/commandline_tools" hreflang="en"><link data-rh="true" rel="alternate" href="https://inlong.apache.org/zh-CN/docs/next/modules/tubemq/commandline_tools" hreflang="zh-CN"><link data-rh="true" rel="alternate" href="https://inlong.apache.org/docs/next/modules/tubemq/commandline_tools" 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="/zh-CN/blog/rss.xml" title="Apache InLong RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/zh-CN/blog/atom.xml" title="Apache InLong Atom Feed">
<link rel="search" type="application/opensearchdescription+xml" title="Apache InLong" href="/zh-CN/opensearch.xml">
<script src="https://www.apachecon.com/event-images/snippet.js" async></script><link rel="stylesheet" href="/zh-CN/assets/css/styles.09deabdb.css">
<link rel="preload" href="/zh-CN/assets/js/runtime~main.933f32cb.js" as="script">
<link rel="preload" href="/zh-CN/assets/js/main.32851df5.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="主导航" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="切换导航栏" 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="/zh-CN/"><div class="navbar__logo"><img src="/zh-CN/img/logo.svg" alt="Apache" class="themedImage_ToTc themedImage--light_HNdA"><img src="/zh-CN/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="/zh-CN/docs/introduction">文档</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/zh-CN/docs/next/introduction">Next</a></li><li><a class="dropdown__link" href="/zh-CN/docs/introduction">1.11.0</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.10.0/introduction">1.10.0</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.9.0/introduction">1.9.0</a></li><li><a class="dropdown__link" href="/zh-CN/docs/1.8.0/introduction">1.8.0</a></li><li><a class="dropdown__link" href="/zh-CN/versions/">All versions</a></li></ul></div><a class="navbar__item navbar__link" href="/zh-CN/downloads">下载</a><a class="navbar__item navbar__link" href="/zh-CN/community/how-to-contribute">社区</a><a class="navbar__item navbar__link" href="/zh-CN/blog">博客</a><a class="navbar__item navbar__link" href="/zh-CN/team">团队</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Apache</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">证书</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">事件</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">安全</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">赞助</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">致谢</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>简体中文</a><ul class="dropdown__menu"><li><a href="/docs/next/modules/tubemq/commandline_tools" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="en">English</a></li><li><a href="/zh-CN/docs/next/modules/tubemq/commandline_tools" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" 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="切换浅色/暗黑模式（当前为浅色模式）" aria-label="切换浅色/暗黑模式（当前为浅色模式）" 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="搜索"><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">搜索</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="回到顶部" 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="文档侧边栏" 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="/zh-CN/docs/next/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="/zh-CN/docs/next/design_and_concept/basic_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="/zh-CN/docs/next/quick_start/how_to_build">快速开始</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="/zh-CN/docs/next/deployment/standalone">安装部署</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="/zh-CN/docs/next/modules/agent/overview">组件介绍</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="/zh-CN/docs/next/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="/zh-CN/docs/next/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="/zh-CN/docs/next/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="/zh-CN/docs/next/modules/tubemq/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="/zh-CN/docs/next/modules/tubemq/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="/zh-CN/docs/next/modules/tubemq/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="/zh-CN/docs/next/modules/tubemq/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="/zh-CN/docs/next/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 menu__link--active" aria-current="page" tabindex="0" href="/zh-CN/docs/next/modules/tubemq/commandline_tools">命令行工具</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="/zh-CN/docs/next/modules/tubemq/client_partition_assign_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="/zh-CN/docs/next/modules/tubemq/client_rpc">客户端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="/zh-CN/docs/next/modules/tubemq/clients_java">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="/zh-CN/docs/next/modules/tubemq/configure_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="/zh-CN/docs/next/modules/tubemq/console_introduction">TubeMQ管控台操作指引</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="/zh-CN/docs/next/modules/tubemq/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" tabindex="0" href="/zh-CN/docs/next/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="/zh-CN/docs/next/modules/tubemq/tubemq_metrics">TubeMQ指标</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="/zh-CN/docs/next/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="/zh-CN/docs/next/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="/zh-CN/docs/next/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="/zh-CN/docs/next/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="/zh-CN/docs/next/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="/zh-CN/docs/next/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="/zh-CN/docs/next/data_node/extract_node/overview">数据节点</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="/zh-CN/docs/next/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="/zh-CN/docs/next/user_guide/dashboard_usage">用户指引</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="/zh-CN/docs/next/development/inlong_msg">开发指引</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="/zh-CN/docs/next/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="/zh-CN/docs/next/contact">联系我们</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 unreleased documentation for <!-- -->Apache InLong<!-- --> <b>Next</b> version.</div><div class="margin-top--md">For up-to-date documentation, see the <b><a href="/zh-CN/docs/modules/tubemq/commandline_tools">latest version</a></b> (<!-- -->1.11.0<!-- -->).</div></div><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="页面路径"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="主页面" class="breadcrumbs__link" href="/zh-CN/"><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">组件介绍</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">命令行工具</span><meta itemprop="position" content="3"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">版本：Next</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>命令行工具</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="总览">总览<a href="#总览" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h2><p>TubeMQ 提供命令行工具来管理主题，生产和消费消息，以及管理消费者组。<br>
<!-- -->命令行工具 <code>tubectl</code> 可以在 TubeMQ 安装路径的 <code>bin</code> 目录下找到。</p><p>用法</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl [options] [command] [command options]</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>命令：</p><ul><li><code>topic</code></li><li><code>message</code></li><li><code>group</code></li></ul><blockquote><p>同时也可以使用 <code>--help</code> 或者 <code>-h</code> 获取上述命令的帮助，例如：</p></blockquote><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl topic -h</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="topic">Topic<a href="#topic" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h2><p><code>topic</code> 命令用于管理主题，包括增删改查等。</p><p>命令：</p><ul><li><code>list</code></li><li><code>update</code></li><li><code>create</code></li><li><code>delete</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list"><code>list</code><a href="#list" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h3><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl topic list</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>选项：</p><table><thead><tr><th align="center"><strong>参数</strong></th><th align="center"><strong>类型</strong></th><th align="center"><strong>描述</strong></th><th align="center"><strong>默认值</strong></th><th align="center"><strong>必需</strong></th></tr></thead><tbody><tr><td align="center">-t, --topic</td><td align="center">String</td><td align="center">topic 名称</td><td align="center"></td><td align="center"></td></tr><tr><td align="center">-sid, --topic-status-id</td><td align="center">Int</td><td align="center">topic 记录状态</td><td align="center">0</td><td align="center"></td></tr><tr><td align="center">-bid, --broker-id</td><td align="center">String</td><td align="center">broker 的 ID，多个 broker 之间以英文逗号间隔</td><td align="center"></td><td align="center"></td></tr><tr><td align="center">-dp, --delete-policy</td><td align="center">String</td><td align="center">topic 数据删除策略，类似 &quot;delete,168&quot; 定义</td><td align="center"></td><td align="center"></td></tr><tr><td align="center">-np, --num-partitions</td><td align="center">Int</td><td align="center">topic 在该 broker 上的分区量</td><td align="center">3</td><td align="center"></td></tr><tr><td align="center">-nts, --num-topic-stores</td><td align="center">Int</td><td align="center">允许建立 topic 数据块和分区管理组的个数</td><td align="center">1</td><td align="center"></td></tr><tr><td align="center">-uft, --unflush-threshold</td><td align="center">Int</td><td align="center">最大允许的待刷新的记录条数</td><td align="center">1000</td><td align="center"></td></tr><tr><td align="center">-ufi, --unflush-interval</td><td align="center">Int</td><td align="center">最大允许的待刷新的间隔</td><td align="center">10000</td><td align="center"></td></tr><tr><td align="center">-ufd, --unflush-dataHold</td><td align="center">Int</td><td align="center">缺省最大允许的待刷新数据大小</td><td align="center">0</td><td align="center"></td></tr><tr><td align="center">-mc, --memcache-msgcnt-ink</td><td align="center">Int</td><td align="center">缺省最大内存缓存包量</td><td align="center">10</td><td align="center"></td></tr><tr><td align="center">-ms, --memcache-msgsize-inmb</td><td align="center">Int</td><td align="center">缺省内存缓存包总的 size 大小</td><td align="center">2</td><td align="center"></td></tr><tr><td align="center">-mfi, --memcache-flush-intvl</td><td align="center">Int</td><td align="center">内存缓存最大允许的待刷新间隔</td><td align="center">20000</td><td align="center"></td></tr><tr><td align="center">-c, --creator</td><td align="center">String</td><td align="center">topic 创建者</td><td align="center"></td><td align="center"></td></tr><tr><td align="center">-m, --modifier</td><td align="center">String</td><td align="center">topic 修改者</td><td align="center"></td><td align="center"></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update"><code>update</code><a href="#update" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h3><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl topic update</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>选项：</p><table><thead><tr><th align="center"><strong>参数</strong></th><th align="center"><strong>类型</strong></th><th align="center"><strong>描述</strong></th><th align="center"><strong>默认值</strong></th><th align="center"><strong>必需</strong></th></tr></thead><tbody><tr><td align="center">-t, --topic</td><td align="center">String</td><td align="center">topic 名称</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-bid, --broker-id</td><td align="center">String</td><td align="center">broker 的 ID，多个 broker 之间以英文逗号间隔</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-m, --modifier</td><td align="center">String</td><td align="center">topic 修改者</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-at, --auth-token</td><td align="center">String</td><td align="center">配置修改授权 key</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-dp, --delete-policy</td><td align="center">String</td><td align="center">topic 数据删除策略，类似 &quot;delete,168&quot; 定义</td><td align="center"></td><td align="center"></td></tr><tr><td align="center">-np, --num-partitions</td><td align="center">Int</td><td align="center">topic 在该 broker 上的分区量</td><td align="center">3</td><td align="center"></td></tr><tr><td align="center">-uft, --unflush-threshold</td><td align="center">Int</td><td align="center">最大允许的待刷新的记录条数</td><td align="center">1000</td><td align="center"></td></tr><tr><td align="center">-ufi, --unflush-interval</td><td align="center">Int</td><td align="center">最大允许的待刷新的间隔</td><td align="center">10000</td><td align="center"></td></tr><tr><td align="center">-ufd, --unflush-datahold</td><td align="center">Int</td><td align="center">缺省最大允许的待刷新数据大小</td><td align="center">0</td><td align="center"></td></tr><tr><td align="center">-nts, --num-topic-stores</td><td align="center">Int</td><td align="center">允许建立 topic 数据块和分区管理组的个数</td><td align="center">1</td><td align="center"></td></tr><tr><td align="center">-mc, --memcache-msgcnt-ink</td><td align="center">Int</td><td align="center">缺省最大内存缓存包量</td><td align="center">10</td><td align="center"></td></tr><tr><td align="center">-ms, --memcache-msgsize-inmb</td><td align="center">Int</td><td align="center">缺省内存缓存包总的 size 大小</td><td align="center">2</td><td align="center"></td></tr><tr><td align="center">-mfi, --memcache-flush-intvl</td><td align="center">Int</td><td align="center">内存缓存最大允许的待刷新间隔</td><td align="center">20000</td><td align="center"></td></tr><tr><td align="center">-ap, --accept-publish</td><td align="center">Boolean</td><td align="center">topic 是否接收发布请求</td><td align="center">true</td><td align="center"></td></tr><tr><td align="center">-as, --accept-subscribe</td><td align="center">Boolean</td><td align="center">topic 是否接收订阅请求</td><td align="center">true</td><td align="center"></td></tr><tr><td align="center">-mms, --max-msgsize-inmb</td><td align="center">Int</td><td align="center">最大消息包长设置</td><td align="center">1</td><td align="center"></td></tr><tr><td align="center">-md, --modify-date</td><td align="center">String</td><td align="center">修改时间</td><td align="center"></td><td align="center"></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create"><code>create</code><a href="#create" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h3><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl create</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>选项：</p><table><thead><tr><th align="center"><strong>参数</strong></th><th align="center"><strong>类型</strong></th><th align="center"><strong>描述</strong></th><th align="center"><strong>默认值</strong></th><th align="center"><strong>必需</strong></th></tr></thead><tbody><tr><td align="center">-t, --topic</td><td align="center">String</td><td align="center">topic 名称</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-bid, --broker-id</td><td align="center">String</td><td align="center">broker 的 ID，多个 broker 之间以英文逗号间隔</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-c, --creator</td><td align="center">String</td><td align="center">topic 创建者</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-at, --auth-token</td><td align="center">String</td><td align="center">配置修改授权 key</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-dp, --delete-policy</td><td align="center">String</td><td align="center">topic 数据删除策略，类似 &quot;delete,168&quot; 定义</td><td align="center"></td><td align="center"></td></tr><tr><td align="center">-np, --num-partitions</td><td align="center">Int</td><td align="center">topic 在该 broker 上的分区量</td><td align="center">-1</td><td align="center"></td></tr><tr><td align="center">-uft, --unflush-threshold</td><td align="center">Int</td><td align="center">最大允许的待刷新的记录条数</td><td align="center">-1</td><td align="center"></td></tr><tr><td align="center">-ufi, --unflush-interval</td><td align="center">Int</td><td align="center">最大允许的待刷新的间隔</td><td align="center">-1</td><td align="center"></td></tr><tr><td align="center">-ufd, --unflush-datahold</td><td align="center">Int</td><td align="center">缺省最大允许的待刷新数据大小</td><td align="center">0</td><td align="center"></td></tr><tr><td align="center">-nts, --num-topic-stores</td><td align="center">Int</td><td align="center">允许建立 topic 数据块和分区管理组的个数</td><td align="center">1</td><td align="center"></td></tr><tr><td align="center">-mc, --memcache-msgcnt-ink</td><td align="center">Int</td><td align="center">缺省最大内存缓存包量</td><td align="center">10</td><td align="center"></td></tr><tr><td align="center">-ms, --memcache-msgsize-inmb</td><td align="center">Int</td><td align="center">缺省内存缓存包总的 size 大小</td><td align="center">2</td><td align="center"></td></tr><tr><td align="center">-mfi, --memcache-flush-intvl</td><td align="center">Int</td><td align="center">内存缓存最大允许的待刷新间隔</td><td align="center">20000</td><td align="center"></td></tr><tr><td align="center">-ap, --accept-publish</td><td align="center">Boolean</td><td align="center">topic 是否接收发布请求</td><td align="center">true</td><td align="center"></td></tr><tr><td align="center">-as, --accept-subscribe</td><td align="center">Boolean</td><td align="center">topic 是否接收订阅请求</td><td align="center">true</td><td align="center"></td></tr><tr><td align="center">-mms, --max-msgsize-inmb</td><td align="center">Int</td><td align="center">最大消息包长设置</td><td align="center">1</td><td align="center"></td></tr><tr><td align="center">-cd, --create-date</td><td align="center">String</td><td align="center">创建时间</td><td align="center"></td><td align="center"></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete"><code>delete</code><a href="#delete" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h3><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl topic delete</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>选项：</p><table><thead><tr><th align="center"><strong>参数</strong></th><th align="center"><strong>类型</strong></th><th align="center"><strong>描述</strong></th><th align="center"><strong>默认值</strong></th><th align="center"><strong>必需</strong></th></tr></thead><tbody><tr><td align="center">-o, --delete-opt</td><td align="center">String</td><td align="center">删除选项，可选值：<code>soft</code>，<code>redo</code>，<code>hard</code></td><td align="center"><code>soft</code></td><td align="center"></td></tr><tr><td align="center">-t, --topic</td><td align="center">String</td><td align="center">topic 名称</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-bid, --broker-id</td><td align="center">String</td><td align="center">broker 的 ID，多个 broker 之间以英文逗号间隔</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-m, --modifier</td><td align="center">String</td><td align="center">topic 修改者</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-at, --auth-token</td><td align="center">String</td><td align="center">配置修改授权 key</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-md, --modify-date</td><td align="center">String</td><td align="center">修改时间</td><td align="center"></td><td align="center"></td></tr></tbody></table><details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>删除选项说明</summary><div><div class="collapsibleContent_i85q"><table><thead><tr><th align="center">删除选项</th><th align="center">描述</th></tr></thead><tbody><tr><td align="center"><code>soft</code></td><td align="center">软删除</td></tr><tr><td align="center"><code>redo</code></td><td align="center">回滚之前的软删除</td></tr><tr><td align="center"><code>hard</code></td><td align="center">硬删除</td></tr></tbody></table></div></div></details><h2 class="anchor anchorWithStickyNavbar_LWe7" id="message">Message<a href="#message" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h2><p><code>message</code> 命令用于生产和消费消息。</p><p>命令：</p><ul><li><code>produce</code></li><li><code>consume</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="produce"><code>produce</code><a href="#produce" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h3><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl message produce</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>选项：</p><table><thead><tr><th align="center"><strong>参数</strong></th><th align="center"><strong>类型</strong></th><th align="center"><strong>描述</strong></th><th align="center"><strong>默认值</strong></th><th align="center"><strong>必需</strong></th></tr></thead><tbody><tr><td align="center">-t, --topic</td><td align="center">String</td><td align="center">topic 名称</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-ms, --master-servers</td><td align="center">String</td><td align="center">连接的 master 地址，格式为 master1_ip:port<!-- -->[<!-- -->,master2_ip:port<!-- -->]</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-mt, --msg-total</td><td align="center">Long</td><td align="center">需要生产的消息总条数，-1表示不限制</td><td align="center">-1</td><td align="center"></td></tr><tr><td align="center">-m, --mode</td><td align="center">String</td><td align="center">生产模式，可选值：<code>sync</code>，<code>async</code></td><td align="center"><code>async</code></td><td align="center"></td></tr></tbody></table><details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>生产模式说明</summary><div><div class="collapsibleContent_i85q"><table><thead><tr><th align="center">生产模式</th><th align="center">描述</th></tr></thead><tbody><tr><td align="center"><code>sync</code></td><td align="center">同步模式</td></tr><tr><td align="center"><code>async</code></td><td align="center">异步模式</td></tr></tbody></table></div></div></details><h3 class="anchor anchorWithStickyNavbar_LWe7" id="consume"><code>consume</code><a href="#consume" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h3><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl message consume</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>选项：</p><table><thead><tr><th align="center"><strong>参数</strong></th><th align="center"><strong>类型</strong></th><th align="center"><strong>描述</strong></th><th align="center"><strong>默认值</strong></th><th align="center"><strong>必需</strong></th></tr></thead><tbody><tr><td align="center">-t, --topic</td><td align="center">String</td><td align="center">topic 名称</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-g, --group</td><td align="center">String</td><td align="center">消费者组</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-ms, --master-servers</td><td align="center">String</td><td align="center">连接的 master 地址，格式为 master1_ip:port<!-- -->[<!-- -->,master2_ip:port<!-- -->]</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-p, --position</td><td align="center">String</td><td align="center">消费位置，可选值：<code>first</code>，<code>latest</code>，<code>max</code></td><td align="center"><code>first</code></td><td align="center"></td></tr><tr><td align="center">-po, --partitions-offsets</td><td align="center">String</td><td align="center">指定消费分区 ID 和 offset ，格式为 id1:offset1<!-- -->[<!-- -->,id2:offset2<!-- -->]<!-- -->，例如：0:0,1:0,2:0</td><td align="center"></td><td align="center"></td></tr><tr><td align="center">-m, --mode</td><td align="center">String</td><td align="center">消费模式，可选值：<code>pull</code>，<code>push</code>，<code>balance</code>；当指定了 -po 参数时，默认使用 <code>balance</code> 模式</td><td align="center"><code>pull</code></td><td align="center"></td></tr></tbody></table><details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>消费位置说明</summary><div><div class="collapsibleContent_i85q"><table><thead><tr><th align="center">消费位置</th><th align="center">描述</th></tr></thead><tbody><tr><td align="center"><code>first</code></td><td align="center">第一次消费时从0开始，否则从上次消费位置开始</td></tr><tr><td align="center"><code>latest</code></td><td align="center">第一次从最新的位置开始，否则从上次消费位置开始</td></tr><tr><td align="center"><code>max</code></td><td align="center">始终从最大消费位置开始</td></tr></tbody></table></div></div></details><details class="details_lb9f alert alert--info details_b_Ee" data-collapsed="true"><summary>消费模式说明</summary><div><div class="collapsibleContent_i85q"><table><thead><tr><th align="center">消费模式</th><th align="center">描述</th></tr></thead><tbody><tr><td align="center"><code>pull</code></td><td align="center">pull 模式</td></tr><tr><td align="center"><code>push</code></td><td align="center">push 模式</td></tr><tr><td align="center"><code>balance</code></td><td align="center">客户端分区分配模式</td></tr></tbody></table></div></div></details><h2 class="anchor anchorWithStickyNavbar_LWe7" id="group">Group<a href="#group" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h2><p><code>group</code> 命令用于消费者组管理，目前支持查询、增加和删除。</p><p>命令：</p><ul><li><code>list</code></li><li><code>create</code></li><li><code>delete</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-1"><code>list</code><a href="#list-1" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h3><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl cgroup list </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>选项：</p><table><thead><tr><th align="center"><strong>参数</strong></th><th align="center"><strong>类型</strong></th><th align="center"><strong>描述</strong></th><th align="center"><strong>默认值</strong></th><th align="center"><strong>必需</strong></th></tr></thead><tbody><tr><td align="center">-t, --topic</td><td align="center">String</td><td align="center">topic 名称</td><td align="center"></td><td align="center"></td></tr><tr><td align="center">-g, --group</td><td align="center">String</td><td align="center">消费者组</td><td align="center"></td><td align="center"></td></tr><tr><td align="center">-c, --creator</td><td align="center">String</td><td align="center">创建者</td><td align="center"></td><td align="center"></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-1"><code>create</code><a href="#create-1" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h3><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl cgroup create</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>选项：</p><table><thead><tr><th align="center"><strong>参数</strong></th><th align="center"><strong>类型</strong></th><th align="center"><strong>描述</strong></th><th align="center"><strong>默认值</strong></th><th align="center"><strong>必需</strong></th></tr></thead><tbody><tr><td align="center">-t, --topic</td><td align="center">String</td><td align="center">topic 名称</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-g, --group</td><td align="center">String</td><td align="center">消费者组</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-at, --auth-token</td><td align="center">String</td><td align="center">配置修改授权 key</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">c, --creator</td><td align="center">String</td><td align="center">创建者</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-cd, --create-date</td><td align="center">String</td><td align="center">创建时间</td><td align="center"></td><td align="center"></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-1"><code>delete</code><a href="#delete-1" class="hash-link" aria-label="Direct link to heading" title="Direct link to heading">​</a></h3><div class="language-shell codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-shell codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ bin/tubectl cgroup delete</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>选项：</p><table><thead><tr><th align="center"><strong>参数</strong></th><th align="center"><strong>类型</strong></th><th align="center"><strong>描述</strong></th><th align="center"><strong>默认值</strong></th><th align="center"><strong>必需</strong></th></tr></thead><tbody><tr><td align="center">-t, --topic</td><td align="center">String</td><td align="center">topic 名称</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-at, --auth-token</td><td align="center">String</td><td align="center">配置修改授权 key</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-m, --modifier</td><td align="center">String</td><td align="center">修改者</td><td align="center"></td><td align="center">是</td></tr><tr><td align="center">-g, --group</td><td align="center">String</td><td align="center">消费者组</td><td align="center"></td><td align="center"></td></tr></tbody></table></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/docs/modules/tubemq/commandline_tools.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="/zh-CN/docs/next/modules/tubemq/tubemq-manager/quick_start"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">安装部署</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/zh-CN/docs/next/modules/tubemq/client_partition_assign_introduction"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">客户端分区分配</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="#总览" class="table-of-contents__link toc-highlight">总览</a></li><li><a href="#topic" class="table-of-contents__link toc-highlight">Topic</a><ul><li><a href="#list" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#update" class="table-of-contents__link toc-highlight"><code>update</code></a></li><li><a href="#create" class="table-of-contents__link toc-highlight"><code>create</code></a></li><li><a href="#delete" class="table-of-contents__link toc-highlight"><code>delete</code></a></li></ul></li><li><a href="#message" class="table-of-contents__link toc-highlight">Message</a><ul><li><a href="#produce" class="table-of-contents__link toc-highlight"><code>produce</code></a></li><li><a href="#consume" class="table-of-contents__link toc-highlight"><code>consume</code></a></li></ul></li><li><a href="#group" class="table-of-contents__link toc-highlight">Group</a><ul><li><a href="#list-1" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#create-1" class="table-of-contents__link toc-highlight"><code>create</code></a></li><li><a href="#delete-1" class="table-of-contents__link toc-highlight"><code>delete</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">事件</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">社区</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">更多</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/zh-CN/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="/zh-CN/img/asf_logo.svg" alt="Apache InLong" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/zh-CN/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="/zh-CN/assets/js/runtime~main.933f32cb.js"></script>
<script src="/zh-CN/assets/js/main.32851df5.js"></script>
</body>
</html>