| <!DOCTYPE html> |
| <html lang="zh-CN" 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-beta.61" /> |
| <meta name="theme" content="VuePress Theme Hope" /> |
| <link rel="alternate" hreflang="en-us" href="https://iotdb.apache.org/UserGuide/V1.2.x/API/RestServiceV1.html"><meta property="og:url" content="https://iotdb.apache.org/zh/UserGuide/V1.2.x/API/RestServiceV1.html"><meta property="og:site_name" content="IoTDB Website"><meta property="og:description" content="RESTful 服务 IoTDB 的 RESTful 服务可用于查询、写入和管理操作，它使用 OpenAPI 标准来定义接口并生成框架。 开启RESTful 服务 RESTful 服务默认情况是关闭的 开发者 ; 找到sever模块中org.apache.iotdb.db.conf.rest 下面的IoTDBRestServiceConfig类，修改e..."><meta property="og:type" content="article"><meta property="og:locale" content="zh-CN"><meta property="og:locale:alternate" content="en-US"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"","image":[""],"dateModified":null,"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"><title>IoTDB Website</title><meta name="description" content="RESTful 服务 IoTDB 的 RESTful 服务可用于查询、写入和管理操作，它使用 OpenAPI 标准来定义接口并生成框架。 开启RESTful 服务 RESTful 服务默认情况是关闭的 开发者 ; 找到sever模块中org.apache.iotdb.db.conf.rest 下面的IoTDBRestServiceConfig类，修改e..."> |
| <style> |
| :root { |
| --bg-color: #fff; |
| } |
| |
| html[data-theme="dark"] { |
| --bg-color: #1d1e1f; |
| } |
| |
| html, |
| body { |
| background: var(--bg-color); |
| } |
| </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="preload" href="/assets/style-2f652485.css" as="style"><link rel="stylesheet" href="/assets/style-2f652485.css"> |
| <link rel="modulepreload" href="/assets/app-cbe6e1e7.js"><link rel="modulepreload" href="/assets/framework-44b8a372.js"><link rel="modulepreload" href="/assets/RestServiceV1.html-7ae7b1e8.js"><link rel="modulepreload" href="/assets/RestServiceV1.html-b42a7ade.js"> |
| </head> |
| <body> |
| <div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="skip-link sr-only">跳至主要內容</a><!--]--><!--[--><div class="theme-container has-toc"><!--[--><header class="navbar hide-icon" id="navbar"><div class="navbar-start"><button class="toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><!----><!--]--><a href="/zh/" class="brand"><img class="logo" src="/logo.png" alt="IoTDB Website"><!----><span class="site-name hide-in-pad">IoTDB Website</span></a><!--[--><!----><!--]--></div><div class="navbar-center"><!--[--><!----><!--]--><!--[--><!----><!--]--></div><div class="navbar-end"><!--[--><!----><!--]--><div id="docsearch-container"></div><nav class="nav-links"><div class="nav-item hide-in-mobile"><div class="dropdown-wrapper"><button class="dropdown-title" type="button" aria-label="文档"><span class="title"><!---->文档</span><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a href="/zh/UserGuide/Master/QuickStart/QuickStart.html" class="nav-link" aria-label="latest"><!---->latest<!----></a></li><li class="dropdown-item"><a href="/zh/UserGuide/V1.2.x/QuickStart/QuickStart.html" class="nav-link" aria-label="v1.2.x"><!---->v1.2.x<!----></a></li><li class="dropdown-item"><a href="/zh/UserGuide/V1.1.x/QuickStart/QuickStart.html" class="nav-link" aria-label="v1.1.x"><!---->v1.1.x<!----></a></li><li class="dropdown-item"><a href="/zh/UserGuide/V1.0.x/QuickStart/QuickStart.html" class="nav-link" aria-label="v1.0.x"><!---->v1.0.x<!----></a></li><li class="dropdown-item"><a href="/zh/UserGuide/V0.13.x/QuickStart/QuickStart.html" class="nav-link" aria-label="v0.13.x"><!---->v0.13.x<!----></a></li></ul></button></div></div><div class="nav-item hide-in-mobile"><a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=177051872" rel="noopener noreferrer" target="_blank" aria-label="系统设计" class="nav-link"><!---->系统设计<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></div><div class="nav-item hide-in-mobile"><a href="/zh/Download/" class="nav-link" aria-label="下载"><!---->下载<!----></a></div><div class="nav-item hide-in-mobile"><div class="dropdown-wrapper"><button class="dropdown-title" type="button" aria-label="社区"><span class="title"><!---->社区</span><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a href="/zh/Community/About.html" class="nav-link" aria-label="关于社区"><!---->关于社区<!----></a></li><li class="dropdown-item"><a href="https://cwiki.apache.org/confluence/display/iotdb" rel="noopener noreferrer" target="_blank" aria-label="Wiki" class="nav-link"><!---->Wiki<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="/zh/Community/Community-Project-Committers.html" class="nav-link" aria-label="开发人员"><!---->开发人员<!----></a></li><li class="dropdown-item"><a href="/zh/Community/Community-Powered-By.html" class="nav-link" aria-label="技术支持"><!---->技术支持<!----></a></li><li class="dropdown-item"><a href="/Community/Materials.html" class="nav-link" aria-label="活动与报告"><!---->活动与报告<!----></a></li><li class="dropdown-item"><a href="/zh/Community/Feedback.html" class="nav-link" aria-label="交流与反馈"><!---->交流与反馈<!----></a></li></ul></button></div></div><div class="nav-item hide-in-mobile"><div class="dropdown-wrapper"><button class="dropdown-title" type="button" aria-label="开发"><span class="title"><!---->开发</span><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a href="/zh/Development/VoteRelease.html" class="nav-link" aria-label="如何投票"><!---->如何投票<!----></a></li><li class="dropdown-item"><a href="/zh/Development/HowToCommit.html" class="nav-link" aria-label="如何提交代码"><!---->如何提交代码<!----></a></li><li class="dropdown-item"><a href="/zh/Development/HowToJoin.html" class="nav-link" aria-label="成为Contributor"><!---->成为Contributor<!----></a></li><li class="dropdown-item"><a href="/zh/Development/Committer.html" class="nav-link" aria-label="成为Committer"><!---->成为Committer<!----></a></li><li class="dropdown-item"><a href="/zh/Development/ContributeGuide.html" class="nav-link" aria-label="项目开发指南"><!---->项目开发指南<!----></a></li><li class="dropdown-item"><a href="/zh/Development/HowtoContributeCode.html" class="nav-link" aria-label="技术贡献指南"><!---->技术贡献指南<!----></a></li><li class="dropdown-item"><a href="/zh/Development/format-changelist.html" class="nav-link" aria-label="TsFile的更改列表"><!---->TsFile的更改列表<!----></a></li><li class="dropdown-item"><a href="/zh/Development/rpc-changelist" class="nav-link" aria-label="RPC变更清单"><!---->RPC变更清单<!----></a></li></ul></button></div></div><div class="nav-item hide-in-mobile"><div class="dropdown-wrapper"><button class="dropdown-title" type="button" aria-label="ASF"><span class="title"><!---->ASF</span><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a href="https://www.apache.org/" rel="noopener noreferrer" target="_blank" aria-label="基金会" class="nav-link"><!---->基金会<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/licenses/" rel="noopener noreferrer" target="_blank" aria-label="许可证" class="nav-link"><!---->许可证<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/security/" rel="noopener noreferrer" target="_blank" aria-label="安全" class="nav-link"><!---->安全<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/foundation/sponsorship.html" rel="noopener noreferrer" target="_blank" aria-label="赞助" class="nav-link"><!---->赞助<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/foundation/thanks.html" rel="noopener noreferrer" target="_blank" aria-label="致谢" class="nav-link"><!---->致谢<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li><li class="dropdown-item"><a href="https://www.apache.org/events/current-event" rel="noopener noreferrer" target="_blank" aria-label="活动" class="nav-link"><!---->活动<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></li></ul></button></div></div></nav><div class="nav-item"><div class="dropdown-wrapper i18n-dropdown"><button class="dropdown-title" type="button" aria-label="选择语言"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" 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="nav-dropdown"><li class="dropdown-item"><a href="/UserGuide/V1.2.x/API/RestServiceV1.html" class="nav-link" aria-label="English"><!---->English<!----></a></li><li class="dropdown-item"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html" class="router-link-active router-link-exact-active nav-link active" aria-label="简体中文"><!---->简体中文<!----></a></li></ul></button></div></div><div class="nav-item hide-in-mobile"><button id="appearance-switch"><svg xmlns="http://www.w3.org/2000/svg" class="icon auto-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="auto icon" style="display:block;"><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" 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" style="display:none;"><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="nav-item"><a class="repo-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" 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 class="toggle-navbar-button" aria-label="Toggle Navbar" aria-expanded="false" aria-controls="nav-screen"><span class="button-container"><span class="button-top"></span><span class="button-middle"></span><span class="button-bottom"></span></span></button></div></header><!----><!--]--><!----><div class="toggle-sidebar-wrapper"><span class="arrow start"></span></div><aside class="sidebar" id="sidebar"><!--[--><!----><!--]--><ul class="sidebar-links"><li><section class="sidebar-group"><p class="sidebar-heading"><!----><span class="title">IoTDB用户手册 (V1.2.x)</span><!----></p><ul class="sidebar-links"></ul></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">关于IoTDB</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">快速上手</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">数据模式与概念</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">语法约定</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable active"><!----><span class="title">应用编程接口</span><span class="arrow down"></span></button><ul class="sidebar-links"><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/Programming-Java-Native-API.html" class="nav-link sidebar-link sidebar-page" aria-label="Java 原生接口"><!---->Java 原生接口<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/Programming-Python-Native-API.html" class="nav-link sidebar-link sidebar-page" aria-label="Python 原生接口"><!---->Python 原生接口<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/Programming-Cpp-Native-API.html" class="nav-link sidebar-link sidebar-page" aria-label="C++ 原生接口"><!---->C++ 原生接口<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/Programming-Go-Native-API.html" class="nav-link sidebar-link sidebar-page" aria-label="Go 原生接口"><!---->Go 原生接口<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/Programming-JDBC.html" class="nav-link sidebar-link sidebar-page" aria-label="JDBC (不推荐)"><!---->JDBC (不推荐)<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/Programming-MQTT.html" class="nav-link sidebar-link sidebar-page" aria-label="MQTT"><!---->MQTT<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html" class="router-link-active router-link-exact-active nav-link active sidebar-link sidebar-page active" aria-label="REST API V1 (不推荐)"><!---->REST API V1 (不推荐)<!----></a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#restful-服务" class="router-link-active router-link-exact-active nav-link sidebar-link heading" aria-label="RESTful 服务"><!---->RESTful 服务<!----></a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#开启restful-服务" class="router-link-active router-link-exact-active nav-link sidebar-link heading" aria-label="开启RESTful 服务"><!---->开启RESTful 服务<!----></a><ul class="sidebar-sub-headers"></ul></li><li class="sidebar-sub-header"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#鉴权" class="router-link-active router-link-exact-active nav-link sidebar-link heading" aria-label="鉴权"><!---->鉴权<!----></a><ul class="sidebar-sub-headers"></ul></li><li class="sidebar-sub-header"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#接口" class="router-link-active router-link-exact-active nav-link sidebar-link heading" aria-label="接口"><!---->接口<!----></a><ul class="sidebar-sub-headers"></ul></li><li class="sidebar-sub-header"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#配置" class="router-link-active router-link-exact-active nav-link sidebar-link heading" aria-label="配置"><!---->配置<!----></a><ul class="sidebar-sub-headers"></ul></li></ul></li></ul><!--]--></li><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/RestServiceV2.html" class="nav-link sidebar-link sidebar-page" aria-label="REST API V2"><!---->REST API V2<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/Programming-TsFile-API.html" class="nav-link sidebar-link sidebar-page" aria-label="TsFile API"><!---->TsFile API<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/InfluxDB-Protocol.html" class="nav-link sidebar-link sidebar-page" aria-label="InfluxDB 协议适配器"><!---->InfluxDB 协议适配器<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li><li><!--[--><a href="/zh/UserGuide/V1.2.x/API/Interface-Comparison.html" class="nav-link sidebar-link sidebar-page" aria-label="原生接口对比"><!---->原生接口对比<!----></a><ul class="sidebar-sub-headers"></ul><!--]--></li></ul></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">元数据操作</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">数据写入（数据更新）</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">数据删除</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">数据查询</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">运算符和函数</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">触发器</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">监控告警</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">权限管理</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">运维工具</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">端云协同</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">系统集成</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">分布式</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">FAQ</span><span class="arrow end"></span></button><!----></section></li><li><section class="sidebar-group"><button class="sidebar-heading clickable"><!----><span class="title">参考</span><span class="arrow end"></span></button><!----></section></li></ul><!--[--><!----><!--]--></aside><!--[--><main class="page" id="main-content"><!--[--><!----><nav class="breadcrumb disable"></nav><div class="page-title"><h1><!----></h1><div class="page-info"><!----><!----><!----><!----><span class="page-reading-time-info" aria-label="阅读时间"><svg xmlns="http://www.w3.org/2000/svg" class="icon timer-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="timer icon"><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>大约 9 分钟</span><meta property="timeRequired" content="PT9M"></span><!----><!----></div><hr></div><div class="toc-place-holder"><aside id="toc"><!--[--><!----><!--]--><div class="toc-header">此页内容<button class="print-button" title="打印"><svg xmlns="http://www.w3.org/2000/svg" class="icon print-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="print icon"><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><div class="toc-wrapper"><ul class="toc-list"><!--[--><li class="toc-item"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#restful-服务" class="router-link-active router-link-exact-active toc-link level2">RESTful 服务</a></li><ul class="toc-list"><!--[--><li class="toc-item"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#开启restful-服务" class="router-link-active router-link-exact-active toc-link level3">开启RESTful 服务</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#鉴权" class="router-link-active router-link-exact-active toc-link level3">鉴权</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#接口" class="router-link-active router-link-exact-active toc-link level3">接口</a></li><!----><!--]--><!--[--><li class="toc-item"><a aria-current="page" href="/zh/UserGuide/V1.2.x/API/RestServiceV1.html#配置" class="router-link-active router-link-exact-active toc-link level3">配置</a></li><!----><!--]--></ul><!--]--></ul></div><!--[--><!----><!--]--></aside></div><!----><div class="theme-hope-content"><!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| |
| --><h2 id="restful-服务" tabindex="-1"><a class="header-anchor" href="#restful-服务" aria-hidden="true">#</a> RESTful 服务</h2><p>IoTDB 的 RESTful 服务可用于查询、写入和管理操作，它使用 OpenAPI 标准来定义接口并生成框架。</p><h3 id="开启restful-服务" tabindex="-1"><a class="header-anchor" href="#开启restful-服务" aria-hidden="true">#</a> 开启RESTful 服务</h3><p>RESTful 服务默认情况是关闭的</p><ul><li><p>开发者</p><p>找到sever模块中<code>org.apache.iotdb.db.conf.rest</code> 下面的<code>IoTDBRestServiceConfig</code>类，修改<code>enableRestService=true</code>即可。</p></li><li><p>使用者</p><p>找到IoTDB安装目录下面的<code>conf/iotdb-common.properties</code>文件，将 <code>enable_rest_service</code> 设置为 <code>true</code> 以启用该模块。</p><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name"> enable_rest_service</span><span class="token punctuation">=</span><span class="token value attr-value">true</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div></li></ul><h3 id="鉴权" tabindex="-1"><a class="header-anchor" href="#鉴权" aria-hidden="true">#</a> 鉴权</h3><p>除了检活接口 <code>/ping</code>，RESTful 服务使用了基础（basic）鉴权，每次 URL 请求都需要在 header 中携带 <code>'Authorization': 'Basic ' + base64.encode(username + ':' + password)</code>。</p><p>示例中使用的用户名为：<code>root</code>，密码为：<code>root</code>，对应的 Basic 鉴权 Header 格式为</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>Authorization: Basic cm9vdDpyb2901 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li><p>若用户名密码认证失败，则返回如下信息：</p><p>HTTP 状态码：<code>401</code></p><p>返回结构体如下</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">600</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"WRONG_LOGIN_PASSWORD_ERROR"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>若未设置 <code>Authorization</code>，则返回如下信息：</p><p>HTTP 状态码：<code>401</code></p><p>返回结构体如下</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">603</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"UNINITIALIZED_AUTH_ERROR"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h3 id="接口" tabindex="-1"><a class="header-anchor" href="#接口" aria-hidden="true">#</a> 接口</h3><h4 id="ping" tabindex="-1"><a class="header-anchor" href="#ping" aria-hidden="true">#</a> ping</h4><p>ping 接口可以用于线上服务检活。</p><p>请求方式：<code>GET</code></p><p>请求路径：<a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a>:port/ping</p><p>请求示例：</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code>$ <span class="token function">curl</span> http://127.0.0.1:18080/ping |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>返回的 HTTP 状态码：</p><ul><li><code>200</code>：当前服务工作正常，可以接收外部请求。</li><li><code>503</code>：当前服务出现异常，不能接收外部请求。</li></ul><p>响应参数：</p><table><thead><tr><th>参数名称</th><th>参数类型</th><th>参数描述</th></tr></thead><tbody><tr><td>code</td><td>integer</td><td>状态码</td></tr><tr><td>message</td><td>string</td><td>信息提示</td></tr></tbody></table><p>响应示例：</p><ul><li><p>HTTP 状态码为 <code>200</code> 时：</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">200</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"SUCCESS_STATUS"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>HTTP 状态码为 <code>503</code> 时：</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">500</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"thrift service is unavailable"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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> 接口访问不需要鉴权。</p></blockquote><h4 id="query" tabindex="-1"><a class="header-anchor" href="#query" aria-hidden="true">#</a> query</h4><p>query 接口可以用于处理数据查询和元数据查询。</p><p>请求方式：<code>POST</code></p><p>请求头：<code>application/json</code></p><p>请求路径：<a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a>:port/rest/v1/query</p><p>参数说明:</p><table><thead><tr><th>参数名称</th><th>参数类型</th><th>是否必填</th><th>参数描述</th></tr></thead><tbody><tr><td>sql</td><td>string</td><td>是</td><td></td></tr><tr><td>rowLimit</td><td>integer</td><td>否</td><td>一次查询能返回的结果集的最大行数。<br>如果不设置该参数，将使用配置文件的 <code>rest_query_default_row_size_limit</code> 作为默认值。<br>当返回结果集的行数超出限制时，将返回状态码 <code>411</code>。</td></tr></tbody></table><p>响应参数:</p><table><thead><tr><th>参数名称</th><th>参数类型</th><th>参数描述</th></tr></thead><tbody><tr><td>expressions</td><td>array</td><td>用于数据查询时结果集列名的数组，用于元数据查询时为<code>null</code></td></tr><tr><td>columnNames</td><td>array</td><td>用于元数据查询结果集列名数组，用于数据查询时为<code>null</code></td></tr><tr><td>timestamps</td><td>array</td><td>时间戳列，用于元数据查询时为<code>null</code></td></tr><tr><td>values</td><td>array</td><td>二维数组，第一维与结果集列名数组的长度相同，第二维数组代表结果集的一列</td></tr></tbody></table><p>请求示例如下所示：</p><p>提示:为了避免OOM问题，不推荐使用select * from root.xx.** 这种查找方式。</p><p>请求示例 表达式查询:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select s3, s4, s3 + 1 from root.sg27 limit 2"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27.s3"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s4"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s3 + 1"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token number">1635232143960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232153960</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">11</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token boolean">false</span><span class="token punctuation">,</span> |
| <span class="token boolean">true</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">12.0</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 show child paths:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show child paths root"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"child paths"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 show child nodes:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show child nodes root"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"child nodes"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"sg28"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 show all ttl:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show all ttl"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"ttl"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 show ttl:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show ttl on root.sg27"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"ttl"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 show functions:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show functions"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"function name"</span><span class="token punctuation">,</span> |
| <span class="token string">"function type"</span><span class="token punctuation">,</span> |
| <span class="token string">"class name (UDF)"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"ABS"</span><span class="token punctuation">,</span> |
| <span class="token string">"ACOS"</span><span class="token punctuation">,</span> |
| <span class="token string">"ASIN"</span><span class="token punctuation">,</span> |
| ... |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"built-in UDTF"</span><span class="token punctuation">,</span> |
| <span class="token string">"built-in UDTF"</span><span class="token punctuation">,</span> |
| <span class="token string">"built-in UDTF"</span><span class="token punctuation">,</span> |
| ... |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"org.apache.iotdb.db.query.udf.builtin.UDTFAbs"</span><span class="token punctuation">,</span> |
| <span class="token string">"org.apache.iotdb.db.query.udf.builtin.UDTFAcos"</span><span class="token punctuation">,</span> |
| <span class="token string">"org.apache.iotdb.db.query.udf.builtin.UDTFAsin"</span><span class="token punctuation">,</span> |
| ... |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 show timeseries:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show timeseries"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"timeseries"</span><span class="token punctuation">,</span> |
| <span class="token string">"alias"</span><span class="token punctuation">,</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"dataType"</span><span class="token punctuation">,</span> |
| <span class="token string">"encoding"</span><span class="token punctuation">,</span> |
| <span class="token string">"compression"</span><span class="token punctuation">,</span> |
| <span class="token string">"tags"</span><span class="token punctuation">,</span> |
| <span class="token string">"attributes"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27.s3"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s4"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28.s3"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28.s4"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"INT32"</span><span class="token punctuation">,</span> |
| <span class="token string">"BOOLEAN"</span><span class="token punctuation">,</span> |
| <span class="token string">"INT32"</span><span class="token punctuation">,</span> |
| <span class="token string">"BOOLEAN"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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 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 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>请求示例 show latest timeseries:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show latest timeseries"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"timeseries"</span><span class="token punctuation">,</span> |
| <span class="token string">"alias"</span><span class="token punctuation">,</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"dataType"</span><span class="token punctuation">,</span> |
| <span class="token string">"encoding"</span><span class="token punctuation">,</span> |
| <span class="token string">"compression"</span><span class="token punctuation">,</span> |
| <span class="token string">"tags"</span><span class="token punctuation">,</span> |
| <span class="token string">"attributes"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg28.s4"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s4"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28.s3"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s3"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg28"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"BOOLEAN"</span><span class="token punctuation">,</span> |
| <span class="token string">"BOOLEAN"</span><span class="token punctuation">,</span> |
| <span class="token string">"INT32"</span><span class="token punctuation">,</span> |
| <span class="token string">"INT32"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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 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 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>请求示例 count timeseries:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"count timeseries root.**"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">4</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 count nodes:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"count nodes root.** level=2"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">4</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 show devices:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show devices"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"devices"</span><span class="token punctuation">,</span> |
| <span class="token string">"isAligned"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"false"</span><span class="token punctuation">,</span> |
| <span class="token string">"false"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 show devices with database:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show devices with database"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"devices"</span><span class="token punctuation">,</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"isAligned"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"false"</span><span class="token punctuation">,</span> |
| <span class="token string">"false"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 list user:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"list user"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"user"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 原始聚合查询:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select count(*) from root.sg27"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count(root.sg27.s3)"</span><span class="token punctuation">,</span> |
| <span class="token string">"count(root.sg27.s4)"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token number">0</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">1</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">2</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 group by level:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select count(*) from root.** group by level = 1"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count(root.sg27.*)"</span><span class="token punctuation">,</span> |
| <span class="token string">"count(root.sg28.*)"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">3</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">3</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 group by:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select count(*) from root.sg27 group by([1635232143960,1635232153960),1s)"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count(root.sg27.s3)"</span><span class="token punctuation">,</span> |
| <span class="token string">"count(root.sg27.s4)"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token number">1635232143960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232144960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232145960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232146960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232147960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232148960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232149960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232150960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232151960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232152960</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">1</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">1</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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 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>请求示例 last:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select last s3 from root.sg27"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"columnNames"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"timeseries"</span><span class="token punctuation">,</span> |
| <span class="token string">"value"</span><span class="token punctuation">,</span> |
| <span class="token string">"dataType"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token number">1635232143960</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27.s3"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"11"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"INT32"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><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>请求示例 disable align:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select * from root.sg27 disable align"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">407</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"disable align clauses are not supported."</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 align by device:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select count(s3) from root.sg27 align by device"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">407</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"align by device clauses are not supported."</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 select into:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select s3, s4 into root.sg29.s1, root.sg29.s2 from root.sg27"}'</span> http://127.0.0.1:18080/rest/v1/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">407</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"select into clauses are not supported."</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="nonquery" tabindex="-1"><a class="header-anchor" href="#nonquery" aria-hidden="true">#</a> nonQuery</h4><p>请求方式：<code>POST</code></p><p>请求头：<code>application/json</code></p><p>请求路径：<a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a>:port/rest/v1/nonQuery</p><p>参数说明:</p><table><thead><tr><th>参数名称</th><th>参数类型</th><th>是否必填</th><th>参数描述</th></tr></thead><tbody><tr><td>sql</td><td>string</td><td>是</td><td></td></tr></tbody></table><p>请求示例:</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"CREATE DATABASE root.ln"}'</span> http://127.0.0.1:18080/rest/v1/nonQuery |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应参数:</p><table><thead><tr><th>参数名称</th><th>参数类型</th><th>参数描述</th></tr></thead><tbody><tr><td>code</td><td>integer</td><td>状态码</td></tr><tr><td>message</td><td>string</td><td>信息提示</td></tr></tbody></table><p>响应示例：</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">200</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"SUCCESS_STATUS"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="inserttablet" tabindex="-1"><a class="header-anchor" href="#inserttablet" aria-hidden="true">#</a> insertTablet</h4><p>请求方式：<code>POST</code></p><p>请求头：<code>application/json</code></p><p>请求路径：<a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span></a>:port/rest/v1/insertTablet</p><p>参数说明:</p><table><thead><tr><th>参数名称</th><th>参数类型</th><th>是否必填</th><th>参数描述</th></tr></thead><tbody><tr><td>timestamps</td><td>array</td><td>是</td><td>时间列</td></tr><tr><td>measurements</td><td>array</td><td>是</td><td>测点名称</td></tr><tr><td>dataTypes</td><td>array</td><td>是</td><td>数据类型</td></tr><tr><td>values</td><td>array</td><td>是</td><td>值列，每一列中的值可以为 <code>null</code></td></tr><tr><td>isAligned</td><td>boolean</td><td>是</td><td>是否是对齐时间序列</td></tr><tr><td>deviceId</td><td>string</td><td>是</td><td>设备名称</td></tr></tbody></table><p>请求示例：</p><div class="language-bash line-numbers-mode" data-ext="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"timestamps":[1635232143960,1635232153960],"measurements":["s3","s4"],"dataTypes":["INT32","BOOLEAN"],"values":[[11,null],[false,true]],"isAligned":false,"deviceId":"root.sg27"}'</span> http://127.0.0.1:18080/rest/v1/insertTablet |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>响应参数：</p><table><thead><tr><th>参数名称</th><th>参数类型</th><th>参数描述</th></tr></thead><tbody><tr><td>code</td><td>integer</td><td>状态码</td></tr><tr><td>message</td><td>string</td><td>信息提示</td></tr></tbody></table><p>响应示例：</p><div class="language-json line-numbers-mode" data-ext="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">200</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"SUCCESS_STATUS"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="配置" tabindex="-1"><a class="header-anchor" href="#配置" aria-hidden="true">#</a> 配置</h3><p>配置位于 <code>iotdb-common.properties</code> 中。</p><ul><li>将 <code>enable_rest_service</code> 设置为 <code>true</code> 以启用该模块，而将 <code>false</code> 设置为禁用该模块。默认情况下，该值为 <code>false</code>。</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">enable_rest_service</span><span class="token punctuation">=</span><span class="token value attr-value">true</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>仅在 <code>enable_rest_service=true</code> 时生效。将 <code>rest_service_port </code>设置为数字（1025~65535），以自定义REST服务套接字端口。默认情况下，值为 <code>18080</code>。</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">rest_service_port</span><span class="token punctuation">=</span><span class="token value attr-value">18080</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>将 'enable_swagger' 设置 'true' 启用swagger来展示rest接口信息, 而设置为 'false' 关闭该功能. 默认情况下，该值为 <code>false</code>。</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">enable_swagger</span><span class="token punctuation">=</span><span class="token value attr-value">false</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>一次查询能返回的结果集最大行数。当返回结果集的行数超出参数限制时，您只会得到在行数范围内的结果集，且将得到状态码<code>411</code>。</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">rest_query_default_row_size_limit</span><span class="token punctuation">=</span><span class="token value attr-value">10000</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>缓存客户登录信息的过期时间（用于加速用户鉴权的速度，单位为秒，默认是8个小时）</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">cache_expire</span><span class="token punctuation">=</span><span class="token value attr-value">28800</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>缓存中存储的最大用户数量（默认是100）</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">cache_max_num</span><span class="token punctuation">=</span><span class="token value attr-value">100</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>缓存初始容量（默认是10）</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">cache_init_num</span><span class="token punctuation">=</span><span class="token value attr-value">10</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>REST Service 是否开启 SSL 配置，将 <code>enable_https</code> 设置为 <code>true</code> 以启用该模块，而将 <code>false</code> 设置为禁用该模块。默认情况下，该值为 <code>false</code>。</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">enable_https</span><span class="token punctuation">=</span><span class="token value attr-value">false</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>keyStore 所在路径（非必填）</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">key_store_path</span><span class="token punctuation">=</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>keyStore 密码（非必填）</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">key_store_pwd</span><span class="token punctuation">=</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>trustStore 所在路径（非必填）</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">trust_store_path</span><span class="token punctuation">=</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>trustStore 密码（非必填）</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">trust_store_pwd</span><span class="token punctuation">=</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>SSL 超时时间，单位为秒</li></ul><div class="language-properties line-numbers-mode" data-ext="properties"><pre class="language-properties"><code><span class="token key attr-name">idle_timeout</span><span class="token punctuation">=</span><span class="token value attr-value">5000</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div></div><!----><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/apache/iotdb/edit/rel/1.2/docs/zh/UserGuide/API/RestServiceV1.md" rel="noopener noreferrer" target="_blank" aria-label="发现错误？在 GitHub 上编辑此页" class="nav-link label"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon"><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><!--]-->发现错误？在 GitHub 上编辑此页<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></div><div class="meta-item git-info"><!----><!----></div></footer><nav class="page-nav"><a href="/zh/UserGuide/V1.2.x/API/Programming-MQTT.html" class="nav-link prev" aria-label="MQTT"><div class="hint"><span class="arrow start"></span>上一页</div><div class="link"><!---->MQTT</div></a><a href="/zh/UserGuide/V1.2.x/API/RestServiceV2.html" class="nav-link next" aria-label="REST API V2"><div class="hint">下一页<span class="arrow end"></span></div><div class="link">REST API V2<!----></div></a></nav><!----><!----><!--]--></main><!--]--><footer style="padding-bottom:2rem;"><span id="doc-version" style="display:none;">rel/1.2</span><p style="text-align:center;color:#909399;font-size:12px;margin:0 30px;">Copyright © 2023 The Apache Software Foundation.<br> Apache and the Apache feather logo are trademarks of The Apache Software Foundation</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"><strong>Have a question?</strong> Connect with us on QQ, WeChat, or Slack. <a href="https://github.com/apache/iotdb/issues/1995">Join the community</a> now.</p><p style="text-align:center;margin-top:10px;color:#909399;font-size:12px;margin:0 30px;"> We use <a href="https://analytics.google.com">Google Analytics</a> to collect anonymous, aggregated usage information. </p></footer></div><!--]--><!--]--><!----><!--]--></div> |
| <script type="module" src="/assets/app-cbe6e1e7.js" defer></script> |
| </body> |
| </html> |
