| import{_ as n,c as a,b as e,o as l}from"./app-BJ81rGGe.js";const o={};function t(p,s){return l(),a("div",null,s[0]||(s[0]=[e(`<h1 id="restful-api-v1-not-recommend" tabindex="-1"><a class="header-anchor" href="#restful-api-v1-not-recommend"><span>RESTful API V1(Not Recommend)</span></a></h1><p>IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks.</p><h2 id="enable-restful-services" tabindex="-1"><a class="header-anchor" href="#enable-restful-services"><span>Enable RESTful Services</span></a></h2><p>RESTful services are disabled by default.</p><p>Find the <code>conf/iotdb.rest.properties</code> file under the IoTDB installation directory and set <code>enable_rest_service</code> to <code>true</code> to enable the module.</p><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_rest_service</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">true</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><h2 id="authentication" tabindex="-1"><a class="header-anchor" href="#authentication"><span>Authentication</span></a></h2><p>Except the liveness probe API <code>/ping</code>, RESTful services use the basic authentication. Each URL request needs to carry <code>'Authorization': 'Basic ' + base64.encode(username + ':' + password)</code>.</p><p>The username used in the following examples is: <code>root</code>, and password is: <code>root</code>.</p><p>And the authorization header is</p><div class="language- line-numbers-mode" data-highlighter="shiki" data-ext="" data-title="" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span>Authorization: Basic cm9vdDpyb290</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li><p>If a user authorized with incorrect username or password, the following error is returned:</p><p>HTTP Status Code：<code>401</code></p><p>HTTP response body:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">600</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"WRONG_LOGIN_PASSWORD_ERROR"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>If the <code>Authorization</code> header is missing，the following error is returned:</p><p>HTTP Status Code：<code>401</code></p><p>HTTP response body:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">603</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"UNINITIALIZED_AUTH_ERROR"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><h2 id="interface" tabindex="-1"><a class="header-anchor" href="#interface"><span>Interface</span></a></h2><h3 id="ping" tabindex="-1"><a class="header-anchor" href="#ping"><span>ping</span></a></h3><p>The <code>/ping</code> API can be used for service liveness probing.</p><p>Request method: <code>GET</code></p><p>Request path: <a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip</a>:port/ping</p><p>The user name used in the example is: root, password: root</p><p>Example request:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">$</span><span style="color:#98C379;"> curl</span><span style="color:#98C379;"> http://127.0.0.1:18080/ping</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Response status codes:</p><ul><li><code>200</code>: The service is alive.</li><li><code>503</code>: The service cannot accept any requests now.</li></ul><p>Response parameters:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">code</td><td style="text-align:left;">integer</td><td style="text-align:left;">status code</td></tr><tr><td style="text-align:left;">message</td><td style="text-align:left;">string</td><td style="text-align:left;">message</td></tr></tbody></table><p>Sample response:</p><ul><li><p>With HTTP status code <code>200</code>:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>With HTTP status code <code>503</code>:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">500</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"thrift service is unavailable"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><blockquote><p><code>/ping</code> can be accessed without authorization.</p></blockquote><h3 id="query" tabindex="-1"><a class="header-anchor" href="#query"><span>query</span></a></h3><p>The query interface can be used to handle data queries and metadata queries.</p><p>Request method: <code>POST</code></p><p>Request header: <code>application/json</code></p><p>Request path: <a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip</a>:port/rest/v1/query</p><p>Parameter Description:</p><table><thead><tr><th>parameter name</th><th>parameter type</th><th>required</th><th>parameter description</th></tr></thead><tbody><tr><td>sql</td><td>string</td><td>yes</td><td></td></tr><tr><td>rowLimit</td><td>integer</td><td>no</td><td>The maximum number of rows in the result set that can be returned by a query. <br>If this parameter is not set, the <code>rest_query_default_row_size_limit</code> of the configuration file will be used as the default value. <br> When the number of rows in the returned result set exceeds the limit, the status code <code>411</code> will be returned.</td></tr></tbody></table><p>Response parameters:</p><table><thead><tr><th>parameter name</th><th>parameter type</th><th>parameter description</th></tr></thead><tbody><tr><td>expressions</td><td>array</td><td>Array of result set column names for data query, <code>null</code> for metadata query</td></tr><tr><td>columnNames</td><td>array</td><td>Array of column names for metadata query result set, <code>null</code> for data query</td></tr><tr><td>timestamps</td><td>array</td><td>Timestamp column, <code>null</code> for metadata query</td></tr><tr><td>values</td><td>array</td><td>A two-dimensional array, the first dimension has the same length as the result set column name array, and the second dimension array represents a column of the result set</td></tr></tbody></table><p><strong>Examples:</strong></p><p>Tip: Statements like <code>select * from root.xx.**</code> are not recommended because those statements may cause OOM.</p><p><strong>Expression query</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select s3, s4, s3 + 1 from root.sg27 limit 2"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: [</span></span> |
| <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;"> "columnNames"</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><strong>Show child paths</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show child paths root"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Show child nodes</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show child nodes root"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Show all ttl</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show all ttl"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Show ttl</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show ttl on root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Show functions</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show functions"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#98C379;"> "function name"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "function type"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "class name (UDF)"</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#E06C75;"> "timestamps"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "values"</span><span style="color:#ABB2BF;">: [</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "ABS"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "ACOS"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "ASIN"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> ...</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "built-in UDTF"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "built-in UDTF"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "built-in UDTF"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> ...</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ],</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> [</span></span> |
| <span class="line"><span style="color:#98C379;"> "org.apache.iotdb.db.query.udf.builtin.UDTFAbs"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "org.apache.iotdb.db.query.udf.builtin.UDTFAcos"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#98C379;"> "org.apache.iotdb.db.query.udf.builtin.UDTFAsin"</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#FFFFFF;"> ...</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;"> ]</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show timeseries</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show timeseries"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Show latest timeseries</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show latest timeseries"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Count timeseries</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"count timeseries root.**"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Count nodes</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"count nodes root.** level=2"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Show devices</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show devices"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Show devices with database</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"show devices with database"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>List user</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"list user"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Aggregation</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(*) from root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: [</span></span> |
| <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;"> "columnNames"</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><strong>Group by level</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(*) from root.** group by level = 1"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Group by</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(*) from root.sg27 group by([1635232143960,1635232153960),1s)"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: [</span></span> |
| <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;"> "columnNames"</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><strong>Last</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select last s3 from root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "expressions"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">null</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "columnNames"</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><strong>Disable align</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select * from root.sg27 disable align"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">407</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"disable align clauses are not supported."</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Align by device</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select count(s3) from root.sg27 align by device"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">407</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"align by device clauses are not supported."</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Select into</strong></p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"select s3, s4 into root.sg29.s1, root.sg29.s2 from root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/query</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">407</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"select into clauses are not supported."</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="nonquery" tabindex="-1"><a class="header-anchor" href="#nonquery"><span>nonQuery</span></a></h3><p>Request method: <code>POST</code></p><p>Request header: <code>application/json</code></p><p>Request path: <a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip</a>:port/rest/v1/nonQuery</p><p>Parameter Description:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">sql</td><td style="text-align:left;">string</td><td style="text-align:left;">query content</td></tr></tbody></table><p>Example request:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"sql":"CREATE DATABASE root.ln"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/nonQuery</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Response parameters:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">code</td><td style="text-align:left;">integer</td><td style="text-align:left;">status code</td></tr><tr><td style="text-align:left;">message</td><td style="text-align:left;">string</td><td style="text-align:left;">message</td></tr></tbody></table><p>Sample response:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="inserttablet" tabindex="-1"><a class="header-anchor" href="#inserttablet"><span>insertTablet</span></a></h3><p>Request method: <code>POST</code></p><p>Request header: <code>application/json</code></p><p>Request path: <a href="http://ip" target="_blank" rel="noopener noreferrer">http://ip</a>:port/rest/v1/insertTablet</p><p>Parameter Description:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">is required</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">timestamps</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Time column</td></tr><tr><td style="text-align:left;">measurements</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The name of the measuring point</td></tr><tr><td style="text-align:left;">dataTypes</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The data type</td></tr><tr><td style="text-align:left;">values</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Value columns, the values in each column can be <code>null</code></td></tr><tr><td style="text-align:left;">isAligned</td><td style="text-align:left;">boolean</td><td style="text-align:left;">yes</td><td style="text-align:left;">Whether to align the timeseries</td></tr><tr><td style="text-align:left;">deviceId</td><td style="text-align:left;">string</td><td style="text-align:left;">yes</td><td style="text-align:left;">Device name</td></tr></tbody></table><p>Example request:</p><div class="language-shell line-numbers-mode" data-highlighter="shiki" data-ext="shell" data-title="shell" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#61AFEF;">curl</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Content-Type:application/json"</span><span style="color:#D19A66;"> -H</span><span style="color:#98C379;"> "Authorization:Basic cm9vdDpyb290"</span><span style="color:#D19A66;"> -X</span><span style="color:#98C379;"> POST</span><span style="color:#D19A66;"> --data</span><span style="color:#98C379;"> '{"timestamps":[1635232143960,1635232153960],"measurements":["s3","s4"],"dataTypes":["INT32","BOOLEAN"],"values":[[11,null],[false,true]],"isAligned":false,"deviceId":"root.sg27"}'</span><span style="color:#98C379;"> http://127.0.0.1:18080/rest/v1/insertTablet</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><p>Sample response:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">code</td><td style="text-align:left;">integer</td><td style="text-align:left;">status code</td></tr><tr><td style="text-align:left;">message</td><td style="text-align:left;">string</td><td style="text-align:left;">message</td></tr></tbody></table><p>Sample response:</p><div class="language-json line-numbers-mode" data-highlighter="shiki" data-ext="json" data-title="json" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#ABB2BF;">{</span></span> |
| <span class="line"><span style="color:#E06C75;"> "code"</span><span style="color:#ABB2BF;">: </span><span style="color:#D19A66;">200</span><span style="color:#ABB2BF;">,</span></span> |
| <span class="line"><span style="color:#E06C75;"> "message"</span><span style="color:#ABB2BF;">: </span><span style="color:#98C379;">"SUCCESS_STATUS"</span></span> |
| <span class="line"><span style="color:#ABB2BF;">}</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="configuration" tabindex="-1"><a class="header-anchor" href="#configuration"><span>Configuration</span></a></h2><p>The configuration is located in 'iotdb-rest.properties'.</p><ul><li>Set 'enable_rest_service' to 'true' to enable the module, and 'false' to disable the module. By default, this value is' false '.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_rest_service</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">true</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>This parameter is valid only when 'enable_REST_service =true'. Set 'rest_service_port' to a number (1025 to 65535) to customize the REST service socket port. By default, the value is 18080.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">rest_service_port</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">18080</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>Set 'enable_swagger' to 'true' to display rest service interface information through swagger, and 'false' to do not display the rest service interface information through the swagger. By default, this value is' false '.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_swagger</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">false</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>The maximum number of rows in the result set that can be returned by a query. When the number of rows in the returned result set exceeds the limit, the status code <code>411</code> is returned.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">rest_query_default_row_size_limit</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">10000</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>Expiration time for caching customer login information (used to speed up user authentication, in seconds, 8 hours by default)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">cache_expire</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">28800</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>Maximum number of users stored in the cache (default: 100)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">cache_max_num</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">100</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>Initial cache size (default: 10)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">cache_init_num</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">10</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>REST Service whether to enable SSL configuration, set 'enable_https' to' true 'to enable the module, and set' false 'to disable the module. By default, this value is' false '.</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">enable_https</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">false</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>keyStore location path (optional)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">key_store_path</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>keyStore password (optional)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">key_store_pwd</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>trustStore location path (optional)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">trust_store_path</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>trustStore password (optional)</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">trust_store_pwd</span><span style="color:#ABB2BF;">=</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div><ul><li>SSL timeout period, in seconds</li></ul><div class="language-properties line-numbers-mode" data-highlighter="shiki" data-ext="properties" data-title="properties" style="background-color:#282c34;color:#abb2bf;"><pre class="shiki one-dark-pro vp-code"><code><span class="line"><span style="color:#C678DD;">idle_timeout</span><span style="color:#ABB2BF;">=</span><span style="color:#98C379;">5000</span></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div></div></div>`,150)]))}const r=n(o,[["render",t],["__file","RestServiceV1.html.vue"]]),c=JSON.parse(`{"path":"/UserGuide/V1.2.x/API/RestServiceV1.html","title":"RESTful API V1(Not Recommend)","lang":"en-US","frontmatter":{"description":"RESTful API V1(Not Recommend) IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate fram...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://iotdb.apache.org/zh/UserGuide/V1.2.x/API/RestServiceV1.html"}],["meta",{"property":"og:url","content":"https://iotdb.apache.org/UserGuide/V1.2.x/API/RestServiceV1.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"RESTful API V1(Not Recommend)"}],["meta",{"property":"og:description","content":"RESTful API V1(Not Recommend) IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate fram..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"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 V1(Not Recommend)\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2024-12-25T11:27:53.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Enable RESTful Services","slug":"enable-restful-services","link":"#enable-restful-services","children":[]},{"level":2,"title":"Authentication","slug":"authentication","link":"#authentication","children":[]},{"level":2,"title":"Interface","slug":"interface","link":"#interface","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":2,"title":"Configuration","slug":"configuration","link":"#configuration","children":[]}],"git":{"createdTime":1688958677000,"updatedTime":1735126073000,"contributors":[{"name":"CritasWang","username":"CritasWang","email":"critas@outlook.com","commits":2,"url":"https://github.com/CritasWang"},{"name":"Lei","username":"Lei","email":"33376433+LeiRui@users.noreply.github.com","commits":1,"url":"https://github.com/Lei"},{"name":"CloudWise-Lukemiao","username":"CloudWise-Lukemiao","email":"76942485+CloudWise-Lukemiao@users.noreply.github.com","commits":1,"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":"W1y1r","username":"W1y1r","email":"150988475+W1y1r@users.noreply.github.com","commits":3,"url":"https://github.com/W1y1r"},{"name":"石林松","username":"石林松","email":"50943998+shi10lin0s@users.noreply.github.com","commits":1,"url":"https://github.com/石林松"}]},"readingTime":{"minutes":6.12,"words":1836},"filePathRelative":"UserGuide/V1.2.x/API/RestServiceV1.md","localizedDate":"July 10, 2023","autoDesc":true}`);export{r as comp,c as data}; |
