| <!doctype html> |
| <html lang="en-US" data-theme="light"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width,initial-scale=1" /> |
| <meta name="generator" content="VuePress 2.0.0-rc.19" /> |
| <meta name="theme" content="VuePress Theme Hope 2.0.0-rc.71" /> |
| <style> |
| :root { |
| --vp-c-bg: #fff; |
| } |
| |
| [data-theme="dark"] { |
| --vp-c-bg: #1b1b1f; |
| } |
| |
| html, |
| body { |
| background: var(--vp-c-bg); |
| } |
| </style> |
| <script> |
| const userMode = localStorage.getItem("vuepress-theme-hope-scheme"); |
| const systemDarkMode = |
| window.matchMedia && |
| window.matchMedia("(prefers-color-scheme: dark)").matches; |
| |
| if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) { |
| document.documentElement.setAttribute("data-theme", "dark"); |
| } |
| </script> |
| <link rel="alternate" hreflang="zh-cn" href="https://iotdb.apache.org/zh/UserGuide/dev-1.3/API/RestServiceV2.html"><meta property="og:url" content="https://iotdb.apache.org/UserGuide/dev-1.3/API/RestServiceV2.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:title" content="RESTful API V2"><meta property="og:description" content="RESTful API V2 IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks. Enable ..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2025-02-21T09:31:28.000Z"><meta property="article:modified_time" content="2025-02-21T09:31:28.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"RESTful API V2","image":[""],"dateModified":"2025-02-21T09:31:28.000Z","author":[]}</script><link rel="icon" href="/favicon.ico"><meta name="Description" content="Apache IoTDB: Time Series Database for IoT"><meta name="Keywords" content="TSDB, time series, time series database, IoTDB, IoT database, IoT data management, 时序数据库, 时间序列管理, IoTDB, 物联网数据库, 实时数据库, 物联网数据管理, 物联网数据"><meta name="baidu-site-verification" content="wfKETzB3OT"><meta name="google-site-verification" content="mZWAoRY0yj_HAr-s47zHCGHzx5Ju-RVm5wDbPnwQYFo"><script type="text/javascript">var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| _paq.push(["setDoNotTrack", true]); |
| _paq.push(["disableCookies"]); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '56']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script><title>RESTful API V2 | IoTDB Website</title><meta name="description" content="RESTful API V2 IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks. Enable ..."> |
| <link rel="preload" href="/assets/style-CI4qIzxp.css" as="style"><link rel="stylesheet" href="/assets/style-CI4qIzxp.css"> |
| <link rel="modulepreload" href="/assets/app-C-fAkKj6.js"><link rel="modulepreload" href="/assets/RestServiceV2.html-XR7KWzoO.js"> |
| |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</a><!--]--><!--[--><div class="theme-container no-sidebar external-link-icon has-toc" vp-container><!--[--><header id="navbar" class="vp-navbar" vp-navbar><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><a class="route-link vp-brand" href="/" aria-label="Take me home"><img class="vp-nav-logo" src="/logo.png" alt><!----><!----></a><!--]--></div><div class="vp-navbar-center"><!--[--><!--]--></div><div class="vp-navbar-end"><!--[--><!--[--><div id="docsearch-container" style="display:none;"></div><div><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"><kbd class="DocSearch-Button-Key"><svg width="15" height="15" class="DocSearch-Control-Key-Icon"><path d="M4.505 4.496h2M5.505 5.496v5M8.216 4.496l.055 5.993M10 7.5c.333.333.5.667.5 1v2M12.326 4.5v5.996M8.384 4.496c1.674 0 2.116 0 2.116 1.5s-.442 1.5-2.116 1.5M3.205 9.303c-.09.448-.277 1.21-1.241 1.203C1 10.5.5 9.513.5 8V7c0-1.57.5-2.5 1.464-2.494.964.006 1.134.598 1.24 1.342M12.553 10.5h1.953" stroke-width="1.2" stroke="currentColor" fill="none" stroke-linecap="square"></path></svg></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--><nav class="vp-nav-links"><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Documentation"><!--[--><!---->Documentation<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/latest/QuickStart/QuickStart_apache.html" aria-label="v2.0.x" iconsizing="both"><!---->v2.0.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.3.x/QuickStart/QuickStart_apache.html" aria-label="v1.3.x" iconsizing="both"><!---->v1.3.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V1.2.x/QuickStart/QuickStart.html" aria-label="v1.2.x" iconsizing="both"><!---->v1.2.x<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/UserGuide/V0.13.x/QuickStart/QuickStart.html" aria-label="v0.13.x" iconsizing="both"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><a class="auto-link external-link" href="https://cwiki.apache.org/confluence/display/IOTDB/System+Design" aria-label="Design" rel="noopener noreferrer" target="_blank" iconsizing="height"><!---->Design<!----></a></div><div class="vp-nav-item hide-in-mobile"><a class="route-link auto-link" href="/Download/" aria-label="Download" iconsizing="height"><!---->Download<!----></a></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Community"><!--[--><!---->Community<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/About-the-Community.html" aria-label="About the Community" iconsizing="both"><!---->About the Community<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Development-Guide.html" aria-label="Development Guide" iconsizing="both"><!---->Development Guide<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Community-Partners.html" aria-label="Community Partners" iconsizing="both"><!---->Community Partners<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Communication-Channels.html" aria-label="Communication Channels" iconsizing="both"><!---->Communication Channels<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Events-and-Reports.html" aria-label="Events and Reports" iconsizing="both"><!---->Events and Reports<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/Community/Committers.html" aria-label="Committers" iconsizing="both"><!---->Committers<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="ASF"><!--[--><!---->ASF<!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/" aria-label="Foundation" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Foundation<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/licenses/" aria-label="License" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->License<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/security/" aria-label="Security" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Security<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/sponsorship.html" aria-label="Sponsorship" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Sponsorship<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/foundation/thanks.html" aria-label="Thanks" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Thanks<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://www.apache.org/events/current-event" aria-label="Current Events" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Current Events<!----></a></li><li class="vp-dropdown-item"><a class="auto-link external-link" href="https://privacy.apache.org/policies/privacy-policy-public.html" aria-label="Privacy" rel="noopener noreferrer" target="_blank" iconsizing="both"><!---->Privacy<!----></a></li></ul></button></div></div></nav><div class="vp-nav-item"><div class="vp-dropdown-wrapper"><button type="button" class="vp-dropdown-title" aria-label="Select language"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" name="i18n" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="vp-dropdown"><li class="vp-dropdown-item"><a class="route-link route-link-active auto-link" href="/UserGuide/dev-1.3/API/RestServiceV2.html" aria-label="English" iconsizing="both"><!---->English<!----></a></li><li class="vp-dropdown-item"><a class="route-link auto-link" href="/zh/UserGuide/dev-1.3/API/RestServiceV2.html" aria-label="简体中文" iconsizing="both"><!---->简体中文<!----></a></li></ul></button></div></div><div class="vp-nav-item hide-in-mobile"><button type="button" class="vp-color-mode-switch" id="color-mode-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" name="auto" style="display:none;"><path d="M512 992C246.92 992 32 777.08 32 512S246.92 32 512 32s480 214.92 480 480-214.92 480-480 480zm0-840c-198.78 0-360 161.22-360 360 0 198.84 161.22 360 360 360s360-161.16 360-360c0-198.78-161.22-360-360-360zm0 660V212c165.72 0 300 134.34 300 300 0 165.72-134.28 300-300 300z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="dark icon" name="dark" style="display:none;"><path d="M524.8 938.667h-4.267a439.893 439.893 0 0 1-313.173-134.4 446.293 446.293 0 0 1-11.093-597.334A432.213 432.213 0 0 1 366.933 90.027a42.667 42.667 0 0 1 45.227 9.386 42.667 42.667 0 0 1 10.24 42.667 358.4 358.4 0 0 0 82.773 375.893 361.387 361.387 0 0 0 376.747 82.774 42.667 42.667 0 0 1 54.187 55.04 433.493 433.493 0 0 1-99.84 154.88 438.613 438.613 0 0 1-311.467 128z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="light icon" name="light" style="display:block;"><path d="M952 552h-80a40 40 0 0 1 0-80h80a40 40 0 0 1 0 80zM801.88 280.08a41 41 0 0 1-57.96-57.96l57.96-58a41.04 41.04 0 0 1 58 58l-58 57.96zM512 752a240 240 0 1 1 0-480 240 240 0 0 1 0 480zm0-560a40 40 0 0 1-40-40V72a40 40 0 0 1 80 0v80a40 40 0 0 1-40 40zm-289.88 88.08-58-57.96a41.04 41.04 0 0 1 58-58l57.96 58a41 41 0 0 1-57.96 57.96zM192 512a40 40 0 0 1-40 40H72a40 40 0 0 1 0-80h80a40 40 0 0 1 40 40zm30.12 231.92a41 41 0 0 1 57.96 57.96l-57.96 58a41.04 41.04 0 0 1-58-58l58-57.96zM512 832a40 40 0 0 1 40 40v80a40 40 0 0 1-80 0v-80a40 40 0 0 1 40-40zm289.88-88.08 58 57.96a41.04 41.04 0 0 1-58 58l-57.96-58a41 41 0 0 1 57.96-57.96z"></path></svg></button></div><div class="vp-nav-item vp-action"><a class="vp-action-link" href="https://github.com/apache/iotdb" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" name="github" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854 22.87C862.25 912.597 1002.667 728.747 1002.667 512c0-271.019-219.648-490.667-490.71-490.667z"></path></svg></a></div><!--]--><button type="button" class="vp-toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span><span class="vp-top"></span><span class="vp-middle"></span><span class="vp-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside id="sidebar" class="vp-sidebar iotdb-sidebar" vp-sidebar><!--[--><p class="vp-sidebar-header iotdb-sidebar-header"><span class="vp-sidebar-title"></span></p><div class="sidebar-top-wrapper"><!----></div><!--]--><ul class="vp-sidebar-links"></ul><!----></aside><!--[--><main id="main-content" class="vp-page"><!--[--><!----><!----><nav class="vp-breadcrumb disable"></nav><div class="vp-page-title"><h1><!---->RESTful API V2</h1><div class="page-info"><!----><!----><span class="page-date-info" aria-label="Writing Date📅" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon calendar-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="calendar icon" name="calendar"><path d="M716.4 110.137c0-18.753-14.72-33.473-33.472-33.473-18.753 0-33.473 14.72-33.473 33.473v33.473h66.993v-33.473zm-334.87 0c0-18.753-14.72-33.473-33.473-33.473s-33.52 14.72-33.52 33.473v33.473h66.993v-33.473zm468.81 33.52H716.4v100.465c0 18.753-14.72 33.473-33.472 33.473a33.145 33.145 0 01-33.473-33.473V143.657H381.53v100.465c0 18.753-14.72 33.473-33.473 33.473a33.145 33.145 0 01-33.473-33.473V143.657H180.6A134.314 134.314 0 0046.66 277.595v535.756A134.314 134.314 0 00180.6 947.289h669.74a134.36 134.36 0 00133.94-133.938V277.595a134.314 134.314 0 00-133.94-133.938zm33.473 267.877H147.126a33.145 33.145 0 01-33.473-33.473c0-18.752 14.72-33.473 33.473-33.473h736.687c18.752 0 33.472 14.72 33.472 33.473a33.145 33.145 0 01-33.472 33.473z"></path></svg><span data-allow-mismatch="text">July 10, 2023</span><meta property="datePublished" content="2023-07-10T03:11:17.000Z"></span><!----><span class="page-reading-time-info" aria-label="Reading Time⌛" data-balloon-pos="up"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon" name="timer"><path d="M799.387 122.15c4.402-2.978 7.38-7.897 7.38-13.463v-1.165c0-8.933-7.38-16.312-16.312-16.312H256.33c-8.933 0-16.311 7.38-16.311 16.312v1.165c0 5.825 2.977 10.874 7.637 13.592 4.143 194.44 97.22 354.963 220.201 392.763-122.204 37.542-214.893 196.511-220.2 389.397-4.661 5.049-7.638 11.651-7.638 19.03v5.825h566.49v-5.825c0-7.379-2.849-13.981-7.509-18.9-5.049-193.016-97.867-351.985-220.2-389.527 123.24-37.67 216.446-198.453 220.588-392.892zM531.16 450.445v352.632c117.674 1.553 211.787 40.778 211.787 88.676H304.097c0-48.286 95.149-87.382 213.728-88.676V450.445c-93.077-3.107-167.901-81.297-167.901-177.093 0-8.803 6.99-15.793 15.793-15.793 8.803 0 15.794 6.99 15.794 15.793 0 80.261 63.69 145.635 142.01 145.635s142.011-65.374 142.011-145.635c0-8.803 6.99-15.793 15.794-15.793s15.793 6.99 15.793 15.793c0 95.019-73.789 172.82-165.96 177.093z"></path></svg><span>About 7 min</span><meta property="timeRequired" content="PT7M"></span><!----><!----></div><hr></div><div class="vp-toc-placeholder"><aside id="toc" vp-toc><!----><!--[--><div class="vp-toc-header">On This Page<button type="button" class="print-button" title="Print"><svg xmlns="http://www.w3.org/2000/svg" class="icon print-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="print icon" name="print"><path d="M819.2 364.8h-44.8V128c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v236.8h-44.8C145.067 364.8 96 413.867 96 473.6v192c0 59.733 49.067 108.8 108.8 108.8h44.8V896c0 17.067 14.933 32 32 32h460.8c17.067 0 32-14.933 32-32V774.4h44.8c59.733 0 108.8-49.067 108.8-108.8v-192c0-59.733-49.067-108.8-108.8-108.8zM313.6 160h396.8v204.8H313.6V160zm396.8 704H313.6V620.8h396.8V864zM864 665.6c0 25.6-19.2 44.8-44.8 44.8h-44.8V588.8c0-17.067-14.933-32-32-32H281.6c-17.067 0-32 14.933-32 32v121.6h-44.8c-25.6 0-44.8-19.2-44.8-44.8v-192c0-25.6 19.2-44.8 44.8-44.8h614.4c25.6 0 44.8 19.2 44.8 44.8v192z"></path></svg></button><div class="arrow end"></div></div><div class="vp-toc-wrapper"><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#enable-restful-services">Enable RESTful Services</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#authentication">Authentication</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#interface">Interface</a></li><li><ul class="vp-toc-list"><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#ping">ping</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#query">query</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#nonquery">nonQuery</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#inserttablet">insertTablet</a></li><!----><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level3" href="#insertrecords">insertRecords</a></li><!----><!--]--></ul></li><!--]--><!--[--><li class="vp-toc-item"><a class="route-link vp-toc-link level2" href="#configuration">Configuration</a></li><!----><!--]--></ul><div class="vp-toc-marker" style="top:-1.7rem;"></div></div><!--]--><!----></aside></div><!----><div class="theme-hope-content" vp-content><h1 id="restful-api-v2" tabindex="-1"><a class="header-anchor" href="#restful-api-v2"><span>RESTful API V2</span></a></h1><p>IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks.</p><h2 id="enable-restful-services" tabindex="-1"><a class="header-anchor" href="#enable-restful-services"><span>Enable RESTful Services</span></a></h2><p>RESTful services are disabled by default.</p><p>Find the <code>conf/iotdb-system.properties</code> file under the IoTDB installation directory and set <code>enable_rest_service</code> to <code>true</code> to enable the module.</p><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_rest_service</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">true</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h2 id="authentication" tabindex="-1"><a class="header-anchor" href="#authentication"><span>Authentication</span></a></h2><p>Except the liveness probe API <code>/ping</code>, RESTful services use the basic authentication. Each URL request needs to carry <code>'Authorization': 'Basic ' + base64.encode(username + ':' + password)</code>.</p><p>The username used in the following examples is: <code>root</code>, and password is: <code>root</code>.</p><p>And the authorization header is</p><div class="language- line-numbers-mode" data-highlighter="shiki" data-ext="" data-title="" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span>Authorization: Basic cm9vdDpyb290</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li><p>If a user authorized with incorrect username or password, the following error is returned:</p><p>HTTP Status Code：<code>401</code></p><p>HTTP response body:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">600</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"WRONG_LOGIN_PASSWORD_ERROR"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>If the <code>Authorization</code> header is missing，the following error is returned:</p><p>HTTP Status Code：<code>401</code></p><p>HTTP response body:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">603</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"UNINITIALIZED_AUTH_ERROR"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h2 id="interface" tabindex="-1"><a class="header-anchor" href="#interface"><span>Interface</span></a></h2><h3 id="ping" tabindex="-1"><a class="header-anchor" href="#ping"><span>ping</span></a></h3><p>The <code>/ping</code> API can be used for service liveness probing.</p><p>Request method: <code>GET</code></p><p>Request path: <code>http://ip:port/ping</code></p><p>The user name used in the example is: root, password: root</p><p>Example request:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">$</span><span style="color:#98C379;"> curl</span><span style="color:#98C379;"> http://127.0.0.1:18080/ping</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Response status codes:</p><ul><li><code>200</code>: The service is alive.</li><li><code>503</code>: The service cannot accept any requests now.</li></ul><p>Response parameters:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">code</td><td style="text-align:left;">integer</td><td style="text-align:left;">status code</td></tr><tr><td style="text-align:left;">message</td><td style="text-align:left;">string</td><td style="text-align:left;">message</td></tr></tbody></table><p>Sample response:</p><ul><li><p>With HTTP status code <code>200</code>:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>With HTTP status code <code>503</code>:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">500</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"thrift service is unavailable"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><blockquote><p><code>/ping</code> can be accessed without authorization.</p></blockquote><h3 id="query" tabindex="-1"><a class="header-anchor" href="#query"><span>query</span></a></h3><p>The query interface can be used to handle data queries and metadata queries.</p><p>Request method: <code>POST</code></p><p>Request header: <code>application/json</code></p><p>Request path: <code>http://ip:port/rest/v2/query</code></p><p>Parameter Description:</p><table><thead><tr><th>parameter name</th><th>parameter type</th><th>required</th><th>parameter description</th></tr></thead><tbody><tr><td>sql</td><td>string</td><td>yes</td><td></td></tr><tr><td>row_limit</td><td>integer</td><td>no</td><td>The maximum number of rows in the result set that can be returned by a query. <br>If this parameter is not set, the <code>rest_query_default_row_size_limit</code> of the configuration file will be used as the default value. <br> When the number of rows in the returned result set exceeds the limit, the status code <code>411</code> will be returned.</td></tr></tbody></table><p>Response parameters:</p><table><thead><tr><th>parameter name</th><th>parameter type</th><th>parameter description</th></tr></thead><tbody><tr><td>expressions</td><td>array</td><td>Array of result set column names for data query, <code>null</code> for metadata query</td></tr><tr><td>column_names</td><td>array</td><td>Array of column names for metadata query result set, <code>null</code> for data query</td></tr><tr><td>timestamps</td><td>array</td><td>Timestamp column, <code>null</code> for metadata query</td></tr><tr><td>values</td><td>array</td><td>A two-dimensional array, the first dimension has the same length as the result set column name array, and the second dimension array represents a column of the result set</td></tr></tbody></table><p><strong>Examples:</strong></p><p>Tip: Statements like <code>select * from root.xx.**</code> are not recommended because those statements may cause OOM.</p><p><strong>Expression query</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select s3, s4, s3 + 1 from root.sg27 limit 2"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"root.sg27.s3"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg27.s4"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg27.s3 + 1"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: [</span><span style="color:#D19A66;">1635232143960</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1635232153960</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">11</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#56B6C2;">false</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">true</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">12.0</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show child paths</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show child paths root"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"child paths"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [[</span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28"</span><span style="color:#ABB2BF;">]]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show child nodes</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show child nodes root"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"child nodes"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [[</span><span style="color:#98C379;">"sg27"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"sg28"</span><span style="color:#ABB2BF;">]]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show all ttl</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show all ttl"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"database"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"ttl"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show ttl</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show ttl on root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"database"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"ttl"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [[</span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">], [</span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">]]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show functions</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show functions"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "function name"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "function type"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "class name (UDF)"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "ABS"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "ACOS"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "ASIN"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> ...</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "built-in UDTF"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "built-in UDTF"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "built-in UDTF"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> ...</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "org.apache.iotdb.db.query.udf.builtin.UDTFAbs"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "org.apache.iotdb.db.query.udf.builtin.UDTFAcos"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "org.apache.iotdb.db.query.udf.builtin.UDTFAsin"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> ...</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show timeseries</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show timeseries"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "timeseries"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "alias"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "database"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "dataType"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "encoding"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "compression"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "tags"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "attributes"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"root.sg27.s3"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg27.s4"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28.s3"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28.s4"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"INT32"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"BOOLEAN"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"INT32"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"BOOLEAN"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"RLE"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"RLE"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"RLE"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"RLE"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"SNAPPY"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"SNAPPY"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"SNAPPY"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"SNAPPY"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show latest timeseries</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show latest timeseries"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "timeseries"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "alias"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "database"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "dataType"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "encoding"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "compression"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "tags"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "attributes"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"root.sg28.s4"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg27.s4"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28.s3"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg27.s3"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"root.sg28"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"BOOLEAN"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"BOOLEAN"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"INT32"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"INT32"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"RLE"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"RLE"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"RLE"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"RLE"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"SNAPPY"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"SNAPPY"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"SNAPPY"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"SNAPPY"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">, </span><span style="color:#56B6C2;">null</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Count timeseries</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"count timeseries root.**"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"count"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [[</span><span style="color:#D19A66;">4</span><span style="color:#ABB2BF;">]]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Count nodes</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"count nodes root.** level=2"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"count"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [[</span><span style="color:#D19A66;">4</span><span style="color:#ABB2BF;">]]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show devices</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show devices"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"devices"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"isAligned"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"false"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"false"</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show devices with database</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show devices with database"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"devices"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"database"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"isAligned"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"root.sg27"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"root.sg28"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#98C379;">"false"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"false"</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>List user</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"list user"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"user"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [[</span><span style="color:#98C379;">"root"</span><span style="color:#ABB2BF;">]]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Aggregation</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(*) from root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"count(root.sg27.s3)"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"count(root.sg27.s4)"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: [</span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [[</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">], [</span><span style="color:#D19A66;">2</span><span style="color:#ABB2BF;">]]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Group by level</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(*) from root.** group by level = 1"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"count(root.sg27.*)"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"count(root.sg28.*)"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [[</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">], [</span><span style="color:#D19A66;">3</span><span style="color:#ABB2BF;">]]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Group by</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(*) from root.sg27 group by([1635232143960,1635232153960),1s)"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"count(root.sg27.s3)"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"count(root.sg27.s4)"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232143960</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1635232144960</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1635232145960</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1635232146960</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1635232147960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232148960</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1635232149960</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1635232150960</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1635232151960</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">1635232152960</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span><span style="color:#D19A66;">1</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">, </span><span style="color:#D19A66;">0</span><span style="color:#ABB2BF;">]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Last</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select last s3 from root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span><span style="color:#98C379;">"timeseries"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"value"</span><span style="color:#ABB2BF;">, </span><span style="color:#98C379;">"dataType"</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: [</span><span style="color:#D19A66;">1635232143960</span><span style="color:#ABB2BF;">],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [[</span><span style="color:#98C379;">"root.sg27.s3"</span><span style="color:#ABB2BF;">], [</span><span style="color:#98C379;">"11"</span><span style="color:#ABB2BF;">], [</span><span style="color:#98C379;">"INT32"</span><span style="color:#ABB2BF;">]]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Disable align</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select * from root.sg27 disable align"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">407</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"disable align clauses are not supported."</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Align by device</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(s3) from root.sg27 align by device"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">407</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"align by device clauses are not supported."</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Select into</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select s3, s4 into root.sg29.s1, root.sg29.s2 from root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">407</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"select into clauses are not supported."</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="nonquery" tabindex="-1"><a class="header-anchor" href="#nonquery"><span>nonQuery</span></a></h3><p>Request method: <code>POST</code></p><p>Request header: <code>application/json</code></p><p>Request path: <code>http://ip:port/rest/v2/nonQuery</code></p><p>Parameter Description:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">sql</td><td style="text-align:left;">string</td><td style="text-align:left;">query content</td></tr></tbody></table><p>Example request:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"CREATE DATABASE root.ln"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/nonQuery</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Response parameters:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">code</td><td style="text-align:left;">integer</td><td style="text-align:left;">status code</td></tr><tr><td style="text-align:left;">message</td><td style="text-align:left;">string</td><td style="text-align:left;">message</td></tr></tbody></table><p>Sample response:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="inserttablet" tabindex="-1"><a class="header-anchor" href="#inserttablet"><span>insertTablet</span></a></h3><p>Request method: <code>POST</code></p><p>Request header: <code>application/json</code></p><p>Request path: <code>http://ip:port/rest/v2/insertTablet</code></p><p>Parameter Description:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">is required</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">timestamps</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Time column</td></tr><tr><td style="text-align:left;">measurements</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The name of the measuring point</td></tr><tr><td style="text-align:left;">data_types</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The data type</td></tr><tr><td style="text-align:left;">values</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Value columns, the values in each column can be <code>null</code></td></tr><tr><td style="text-align:left;">is_aligned</td><td style="text-align:left;">boolean</td><td style="text-align:left;">yes</td><td style="text-align:left;">Whether to align the timeseries</td></tr><tr><td style="text-align:left;">device</td><td style="text-align:left;">string</td><td style="text-align:left;">yes</td><td style="text-align:left;">Device name</td></tr></tbody></table><p>Example request:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"timestamps":[1635232143960,1635232153960],"measurements":["s3","s4"],"data_types":["INT32","BOOLEAN"],"values":[[11,null],[false,true]],"is_aligned":false,"device":"root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/insertTablet</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Sample response:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">code</td><td style="text-align:left;">integer</td><td style="text-align:left;">status code</td></tr><tr><td style="text-align:left;">message</td><td style="text-align:left;">string</td><td style="text-align:left;">message</td></tr></tbody></table><p>Sample response:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="insertrecords" tabindex="-1"><a class="header-anchor" href="#insertrecords"><span>insertRecords</span></a></h3><p>Request method: <code>POST</code></p><p>Request header: <code>application/json</code></p><p>Request path: <code>http://ip:port/rest/v2/insertRecords</code></p><p>Parameter Description:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">is required</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">timestamps</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Time column</td></tr><tr><td style="text-align:left;">measurements_list</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The name of the measuring point</td></tr><tr><td style="text-align:left;">data_types_list</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The data type</td></tr><tr><td style="text-align:left;">values_list</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Value columns, the values in each column can be <code>null</code></td></tr><tr><td style="text-align:left;">devices</td><td style="text-align:left;">string</td><td style="text-align:left;">yes</td><td style="text-align:left;">Device name</td></tr><tr><td style="text-align:left;">is_aligned</td><td style="text-align:left;">boolean</td><td style="text-align:left;">yes</td><td style="text-align:left;">Whether to align the timeseries</td></tr></tbody></table><p>Example request:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"timestamps":[1635232113960,1635232151960,1635232143960,1635232143960],"measurements_list":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"data_types_list":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"values_list":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"is_aligned":false,"devices":["root.s1","root.s1","root.s1","root.s3"]}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/insertRecords</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Sample response:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">code</td><td style="text-align:left;">integer</td><td style="text-align:left;">status code</td></tr><tr><td style="text-align:left;">message</td><td style="text-align:left;">string</td><td style="text-align:left;">message</td></tr></tbody></table><p>Sample response:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="configuration" tabindex="-1"><a class="header-anchor" href="#configuration"><span>Configuration</span></a></h2><p>The configuration is located in 'iotdb-system.properties'.</p><ul><li>Set 'enable_rest_service' to 'true' to enable the module, and 'false' to disable the module. By default, this value is' false '.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_rest_service</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">true</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>This parameter is valid only when 'enable_REST_service =true'. Set 'rest_service_port' to a number (1025 to 65535) to customize the REST service socket port. By default, the value is 18080.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">rest_service_port</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">18080</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>Set 'enable_swagger' to 'true' to display rest service interface information through swagger, and 'false' to do not display the rest service interface information through the swagger. By default, this value is' false '.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_swagger</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">false</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>The maximum number of rows in the result set that can be returned by a query. When the number of rows in the returned result set exceeds the limit, the status code <code>411</code> is returned.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">rest_query_default_row_size_limit</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">10000</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>Expiration time for caching customer login information (used to speed up user authentication, in seconds, 8 hours by default)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">cache_expire</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">28800</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>Maximum number of users stored in the cache (default: 100)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">cache_max_num</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">100</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>Initial cache size (default: 10)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">cache_init_num</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">10</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>REST Service whether to enable SSL configuration, set 'enable_https' to' true 'to enable the module, and set' false 'to disable the module. By default, this value is' false '.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_https</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">false</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>keyStore location path (optional)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">key_store_path</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>keyStore password (optional)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">key_store_pwd</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>trustStore location path (optional)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">trust_store_path</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>trustStore password (optional)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">trust_store_pwd</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>SSL timeout period, in seconds</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">idle_timeout</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">5000</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div></div><!----><footer class="vp-page-meta"><div class="vp-meta-item edit-link"><a class="auto-link external-link vp-meta-label" href="https://github.com/apache/iotdb-docs/edit/main/src/UserGuide/dev-1.3/API/RestServiceV2.md" aria-label="Found Error? Edit this page on GitHub" rel="noopener noreferrer" target="_blank" iconsizing="both"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon" name="edit"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->Found Error? Edit this page on GitHub<!----></a></div><div class="vp-meta-item git-info"><div class="update-time"><span class="vp-meta-label">Last update: </span><span class="vp-meta-info" data-allow-mismatch="text">2/21/2025, 9:31:28 AM</span></div><!----></div></footer><!----><!----><!----><!--]--></main><!--]--><footer class="site-footer"><span id="doc-version" style="display:none;">dev-1.3</span><p class="copyright-text">Copyright © 2025 The Apache Software Foundation. |
| Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Having questions?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a></p></footer></div><!--]--><!--]--><!--[--><!----><!--]--><!--]--></div> |
| <script type="module" src="/assets/app-C-fAkKj6.js" defer></script> |
| </body> |
| </html> |
