| import{_ as n,c as a,b as l,o as e}from"./app-C8175JBb.js";const o={};function p(t,s){return e(),a("div",null,s[0]||(s[0]=[l(`<h1 id="restful-api-v2" tabindex="-1"><a class="header-anchor" href="#restful-api-v2"><span>RESTful API V2</span></a></h1><p>IoTDB 的 RESTful 服务可用于查询、写入和管理操作，它使用 OpenAPI 标准来定义接口并生成框架。</p><h2 id="开启restful-服务" tabindex="-1"><a class="header-anchor" href="#开启restful-服务"><span>开启RESTful 服务</span></a></h2><p>RESTful 服务默认情况是关闭的</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-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;"> enable_rest_service</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">true</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h2 id="鉴权" tabindex="-1"><a class="header-anchor" href="#鉴权"><span>鉴权</span></a></h2><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- line-numbers-mode" data-highlighter="shiki" data-ext="" data-title="" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span>Authorization: Basic cm9vdDpyb290</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li><p>若用户名密码认证失败，则返回如下信息：</p><p>HTTP 状态码：<code>401</code></p><p>返回结构体如下</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">600</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"WRONG_LOGIN_PASSWORD_ERROR"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>若未设置 <code>Authorization</code>，则返回如下信息：</p><p>HTTP 状态码：<code>401</code></p><p>返回结构体如下</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">603</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"UNINITIALIZED_AUTH_ERROR"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h2 id="接口" tabindex="-1"><a class="header-anchor" href="#接口"><span>接口</span></a></h2><h3 id="ping" tabindex="-1"><a class="header-anchor" href="#ping"><span>ping</span></a></h3><p>ping 接口可以用于线上服务检活。</p><p>请求方式：<code>GET</code></p><p>请求路径：<a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip</a>:port/ping</p><p>请求示例：</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">$</span><span style="color:#98C379;"> curl</span><span style="color:#98C379;"> http://127.0.0.1:18080/ping</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>返回的 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-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>HTTP 状态码为 <code>503</code> 时：</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">500</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"thrift service is unavailable"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><blockquote><p><code>/ping</code> 接口访问不需要鉴权。</p></blockquote><h3 id="query" tabindex="-1"><a class="header-anchor" href="#query"><span>query</span></a></h3><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</a>:port/rest/v2/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>row_limit</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>column_names</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-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select s3, s4, s3 + 1 from root.sg27 limit 2"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27.s3"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27.s4"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27.s3 + 1"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232143960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232153960</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 11</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#56B6C2;"> false</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> true</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 12.0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 show child paths:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show child paths root"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "child paths"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 show child nodes:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show child nodes root"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "child nodes"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "sg27"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "sg28"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 show all ttl:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show all ttl"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "database"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "ttl"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 show ttl:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show ttl on root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "database"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "ttl"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 show functions:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show functions"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "function name"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "function type"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "class name (UDF)"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "ABS"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "ACOS"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "ASIN"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> ...</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "built-in UDTF"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "built-in UDTF"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "built-in UDTF"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> ...</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "org.apache.iotdb.db.query.udf.builtin.UDTFAbs"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "org.apache.iotdb.db.query.udf.builtin.UDTFAcos"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "org.apache.iotdb.db.query.udf.builtin.UDTFAsin"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> ...</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 show timeseries:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show timeseries"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "timeseries"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "alias"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "database"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "dataType"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "encoding"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "compression"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "tags"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "attributes"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27.s3"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27.s4"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28.s3"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28.s4"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "INT32"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "BOOLEAN"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "INT32"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "BOOLEAN"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "RLE"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "RLE"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "RLE"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "RLE"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "SNAPPY"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "SNAPPY"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "SNAPPY"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "SNAPPY"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show latest timeseries"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "timeseries"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "alias"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "database"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "dataType"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "encoding"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "compression"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "tags"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "attributes"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28.s4"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27.s4"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28.s3"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27.s3"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "BOOLEAN"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "BOOLEAN"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "INT32"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "INT32"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "RLE"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "RLE"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "RLE"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "RLE"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "SNAPPY"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "SNAPPY"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "SNAPPY"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "SNAPPY"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#56B6C2;"> null</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"count timeseries root.**"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "count"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 4</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 count nodes:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"count nodes root.** level=2"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "count"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 4</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 show devices:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show devices"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "devices"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "isAligned"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "false"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "false"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 show devices with database:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show devices with database"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "devices"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "database"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "isAligned"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg28"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "false"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "false"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 list user:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"list user"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "user"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 原始聚合查询:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(*) from root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "count(root.sg27.s3)"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "count(root.sg27.s4)"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 2</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 group by level:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(*) from root.** group by level = 1"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "count(root.sg27.*)"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "count(root.sg28.*)"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 3</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 3</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 group by:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(*) from root.sg27 group by([1635232143960,1635232153960),1s)"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "count(root.sg27.s3)"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "count(root.sg27.s4)"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232143960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232144960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232145960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232146960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232147960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232148960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232149960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232150960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232151960</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232152960</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#D19A66;"> 0</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="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-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select last s3 from root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "column_names"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "timeseries"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "value"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "dataType"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#D19A66;"> 1635232143960</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "root.sg27.s3"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "11"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "INT32"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 disable align:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select * from root.sg27 disable align"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">407</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"disable align clauses are not supported."</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 align by device:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(s3) from root.sg27 align by device"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">407</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"align by device clauses are not supported."</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>请求示例 select into:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select s3, s4 into root.sg29.s1, root.sg29.s2 from root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应示例:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">407</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"select into clauses are not supported."</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="nonquery" tabindex="-1"><a class="header-anchor" href="#nonquery"><span>nonQuery</span></a></h3><p>请求方式：<code>POST</code></p><p>请求头：<code>application/json</code></p><p>请求路径：<a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip</a>:port/rest/v2/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-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"CREATE DATABASE root.ln"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/nonQuery</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应参数:</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-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="inserttablet" tabindex="-1"><a class="header-anchor" href="#inserttablet"><span>insertTablet</span></a></h3><p>请求方式：<code>POST</code></p><p>请求头：<code>application/json</code></p><p>请求路径：<a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip</a>:port/rest/v2/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>data_types</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>is_aligned</td><td>boolean</td><td>是</td><td>是否是对齐时间序列</td></tr><tr><td>device</td><td>string</td><td>是</td><td>设备名称</td></tr></tbody></table><p>请求示例：</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"timestamps":[1635232143960,1635232153960],"measurements":["s3","s4"],"data_types":["INT32","BOOLEAN"],"values":[[11,null],[false,true]],"is_aligned":false,"device":"root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/insertTablet</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应参数：</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-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="insertrecords" tabindex="-1"><a class="header-anchor" href="#insertrecords"><span>insertRecords</span></a></h3><p>请求方式：<code>POST</code></p><p>请求头：<code>application/json</code></p><p>请求路径：<a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip</a>:port/rest/v2/insertRecords</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_list</td><td>array</td><td>是</td><td>测点名称</td></tr><tr><td>data_types_list</td><td>array</td><td>是</td><td>数据类型</td></tr><tr><td>values_list</td><td>array</td><td>是</td><td>值列，每一列中的值可以为 <code>null</code></td></tr><tr><td>devices</td><td>string</td><td>是</td><td>设备名称</td></tr><tr><td>is_aligned</td><td>string</td><td>是</td><td>是否是对齐时间序列</td></tr></tbody></table><p>请求示例：</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"timestamps":[1635232113960,1635232151960,1635232143960,1635232143960],"measurements_list":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"data_types_list":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"values_list":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"is_aligned":false,"devices":["root.s1","root.s1","root.s1","root.s3"]}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v2/insertRecords</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>响应参数：</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-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="配置" tabindex="-1"><a class="header-anchor" href="#配置"><span>配置</span></a></h2><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-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_rest_service</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">true</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>仅在 <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-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">rest_service_port</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">18080</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>将 'enable_swagger' 设置 'true' 启用swagger来展示rest接口信息, 而设置为 'false' 关闭该功能. 默认情况下，该值为 <code>false</code>。</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_swagger</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">false</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>一次查询能返回的结果集最大行数。当返回结果集的行数超出参数限制时，您只会得到在行数范围内的结果集，且将得到状态码<code>411</code>。</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">rest_query_default_row_size_limit</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">10000</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>缓存客户登录信息的过期时间（用于加速用户鉴权的速度，单位为秒，默认是8个小时）</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">cache_expire</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">28800</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>缓存中存储的最大用户数量（默认是100）</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">cache_max_num</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">100</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>缓存初始容量（默认是10）</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">cache_init_num</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">10</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>REST Service 是否开启 SSL 配置，将 <code>enable_https</code> 设置为 <code>true</code> 以启用该模块，而将 <code>false</code> 设置为禁用该模块。默认情况下，该值为 <code>false</code>。</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_https</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">false</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>keyStore 所在路径（非必填）</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">key_store_path</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>keyStore 密码（非必填）</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">key_store_pwd</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>trustStore 所在路径（非必填）</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">trust_store_path</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>trustStore 密码（非必填）</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">trust_store_pwd</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>SSL 超时时间，单位为秒</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">idle_timeout</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">5000</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div>`,180)]))}const r=n(o,[["render",p],["__file","RestServiceV2.html.vue"]]),c=JSON.parse('{"path":"/zh/UserGuide/V1.2.x/API/RestServiceV2.html","title":"RESTful API V2","lang":"zh-CN","frontmatter":{"description":"RESTful API V2 IoTDB 的 RESTful 服务可用于查询、写入和管理操作，它使用 OpenAPI 标准来定义接口并生成框架。 开启RESTful 服务 RESTful 服务默认情况是关闭的 找到IoTDB安装目录下面的conf/iotdb-common.properties文件，将 enable_rest_service 设置为 t...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://iotdb.apache.org/UserGuide/V1.2.x/API/RestServiceV2.html"}],["meta",{"property":"og:url","content":"https://iotdb.apache.org/zh/UserGuide/V1.2.x/API/RestServiceV2.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"RESTful API V2"}],["meta",{"property":"og:description","content":"RESTful API V2 IoTDB 的 RESTful 服务可用于查询、写入和管理操作，它使用 OpenAPI 标准来定义接口并生成框架。 开启RESTful 服务 RESTful 服务默认情况是关闭的 找到IoTDB安装目录下面的conf/iotdb-common.properties文件，将 enable_rest_service 设置为 t..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2024-12-25T11:27:53.000Z"}],["meta",{"property":"article:modified_time","content":"2024-12-25T11:27:53.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"RESTful API V2\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2024-12-25T11:27:53.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"开启RESTful 服务","slug":"开启restful-服务","link":"#开启restful-服务","children":[]},{"level":2,"title":"鉴权","slug":"鉴权","link":"#鉴权","children":[]},{"level":2,"title":"接口","slug":"接口","link":"#接口","children":[{"level":3,"title":"ping","slug":"ping","link":"#ping","children":[]},{"level":3,"title":"query","slug":"query","link":"#query","children":[]},{"level":3,"title":"nonQuery","slug":"nonquery","link":"#nonquery","children":[]},{"level":3,"title":"insertTablet","slug":"inserttablet","link":"#inserttablet","children":[]},{"level":3,"title":"insertRecords","slug":"insertrecords","link":"#insertrecords","children":[]}]},{"level":2,"title":"配置","slug":"配置","link":"#配置","children":[]}],"git":{"createdTime":1688958677000,"updatedTime":1735126073000,"contributors":[{"name":"CritasWang","username":"CritasWang","email":"critas@outlook.com","commits":1,"url":"https://github.com/CritasWang"},{"name":"wanghui42","username":"wanghui42","email":"105700158+wanghui42@users.noreply.github.com","commits":1,"url":"https://github.com/wanghui42"},{"name":"Haonan","username":"Haonan","email":"hhaonan@outlook.com","commits":1,"url":"https://github.com/Haonan"},{"name":"CloudWise-Lukemiao","username":"CloudWise-Lukemiao","email":"76942485+CloudWise-Lukemiao@users.noreply.github.com","commits":2,"url":"https://github.com/CloudWise-Lukemiao"},{"name":"Cloudwise_Luke","username":"Cloudwise_Luke","email":"282583553@qq.com","commits":1,"url":"https://github.com/Cloudwise_Luke"},{"name":"Zhijia Cao","username":"Zhijia Cao","email":"caozhijia@126.com","commits":1,"url":"https://github.com/Zhijia Cao"},{"name":"石林松","username":"石林松","email":"50943998+shi10lin0s@users.noreply.github.com","commits":1,"url":"https://github.com/石林松"},{"name":"W1y1r","username":"W1y1r","email":"150988475+W1y1r@users.noreply.github.com","commits":2,"url":"https://github.com/W1y1r"}]},"readingTime":{"minutes":8.47,"words":2541},"filePathRelative":"zh/UserGuide/V1.2.x/API/RestServiceV2.md","localizedDate":"2023年7月10日","autoDesc":true}');export{r as comp,c as data}; |
