| import{_ as l,r as o,o as p,c as i,b as s,d as n,a as t,e as a}from"./app-Bx8hKGcu.js";const u={},r=a(`<h1 id="restful-services" tabindex="-1"><a class="header-anchor" href="#restful-services"><span>RESTful Services</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><ul><li><p>Developer</p><p>Find the <code>IoTDBrestServiceConfig</code> class under <code>org.apache.iotdb.db.conf.rest</code> in the sever module, and modify <code>enableRestService=true</code>.</p></li><li><p>User</p><p>Find the <code>conf/iotdb-datanode.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-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">enable_rest_service</span><span class="token punctuation">=</span><span class="token value attr-value">true</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div></li></ul><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-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>Authorization: Basic cm9vdDpyb2901 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li><p>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-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">600</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"WRONG_LOGIN_PASSWORD_ERROR"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>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-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">603</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"UNINITIALIZED_AUTH_ERROR"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><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>`,15),c={href:"http://ip",target:"_blank",rel:"noopener noreferrer"},d=a(`<p>The user name used in the example is: root, password: root</p><p>Example request:</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code>$ <span class="token function">curl</span> http://127.0.0.1:18080/ping |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>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-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">200</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"SUCCESS_STATUS"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li><li><p>With HTTP status code <code>503</code>:</p><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">500</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"thrift service is unavailable"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></li></ul><blockquote><p><code>/ping</code> 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>`,14),v={href:"http://ip",target:"_blank",rel:"noopener noreferrer"},m=a(`<p>Parameter Description:</p><table><thead><tr><th>parameter name</th><th>parameter type</th><th>required</th><th>parameter description</th></tr></thead><tbody><tr><td>sql</td><td>string</td><td>yes</td><td></td></tr><tr><td>row_limit</td><td>integer</td><td>no</td><td>The maximum number of rows in the result set that can be returned by a query. <br>If this parameter is not set, the <code>rest_query_default_row_size_limit</code> of the configuration file will be used as the default value. <br> When the number of rows in the returned result set exceeds the limit, the status code <code>411</code> will be returned.</td></tr></tbody></table><p>Response parameters:</p><table><thead><tr><th>parameter name</th><th>parameter type</th><th>parameter description</th></tr></thead><tbody><tr><td>expressions</td><td>array</td><td>Array of result set column names for data query, <code>null</code> for metadata query</td></tr><tr><td>column_names</td><td>array</td><td>Array of column names for metadata query result set, <code>null</code> for data query</td></tr><tr><td>timestamps</td><td>array</td><td>Timestamp column, <code>null</code> for metadata query</td></tr><tr><td>values</td><td>array</td><td>A two-dimensional array, the first dimension has the same length as the result set column name array, and the second dimension array represents a column of the result set</td></tr></tbody></table><p><strong>Examples:</strong></p><p>Tip: Statements like <code>select * from root.xx.**</code> are not recommended because those statements may cause OOM.</p><p><strong>Expression query</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select s3, s4, s3 + 1 from root.sg27 limit 2"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27.s3"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s4"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s3 + 1"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token number">1635232143960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232153960</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">11</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token boolean">false</span><span class="token punctuation">,</span> |
| <span class="token boolean">true</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">12.0</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show child paths</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show child paths root"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"child paths"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show child nodes</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show child nodes root"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"child nodes"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"sg28"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show all ttl</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show all ttl"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"ttl"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show ttl</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show ttl on root.sg27"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"ttl"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show functions</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show functions"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"function name"</span><span class="token punctuation">,</span> |
| <span class="token string">"function type"</span><span class="token punctuation">,</span> |
| <span class="token string">"class name (UDF)"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"ABS"</span><span class="token punctuation">,</span> |
| <span class="token string">"ACOS"</span><span class="token punctuation">,</span> |
| <span class="token string">"ASIN"</span><span class="token punctuation">,</span> |
| ... |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"built-in UDTF"</span><span class="token punctuation">,</span> |
| <span class="token string">"built-in UDTF"</span><span class="token punctuation">,</span> |
| <span class="token string">"built-in UDTF"</span><span class="token punctuation">,</span> |
| ... |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"org.apache.iotdb.db.query.udf.builtin.UDTFAbs"</span><span class="token punctuation">,</span> |
| <span class="token string">"org.apache.iotdb.db.query.udf.builtin.UDTFAcos"</span><span class="token punctuation">,</span> |
| <span class="token string">"org.apache.iotdb.db.query.udf.builtin.UDTFAsin"</span><span class="token punctuation">,</span> |
| ... |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show timeseries</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show timeseries"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"timeseries"</span><span class="token punctuation">,</span> |
| <span class="token string">"alias"</span><span class="token punctuation">,</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"dataType"</span><span class="token punctuation">,</span> |
| <span class="token string">"encoding"</span><span class="token punctuation">,</span> |
| <span class="token string">"compression"</span><span class="token punctuation">,</span> |
| <span class="token string">"tags"</span><span class="token punctuation">,</span> |
| <span class="token string">"attributes"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27.s3"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s4"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28.s3"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28.s4"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"INT32"</span><span class="token punctuation">,</span> |
| <span class="token string">"BOOLEAN"</span><span class="token punctuation">,</span> |
| <span class="token string">"INT32"</span><span class="token punctuation">,</span> |
| <span class="token string">"BOOLEAN"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show latest timeseries</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show latest timeseries"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"timeseries"</span><span class="token punctuation">,</span> |
| <span class="token string">"alias"</span><span class="token punctuation">,</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"dataType"</span><span class="token punctuation">,</span> |
| <span class="token string">"encoding"</span><span class="token punctuation">,</span> |
| <span class="token string">"compression"</span><span class="token punctuation">,</span> |
| <span class="token string">"tags"</span><span class="token punctuation">,</span> |
| <span class="token string">"attributes"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg28.s4"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s4"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28.s3"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27.s3"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg28"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg27"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"BOOLEAN"</span><span class="token punctuation">,</span> |
| <span class="token string">"BOOLEAN"</span><span class="token punctuation">,</span> |
| <span class="token string">"INT32"</span><span class="token punctuation">,</span> |
| <span class="token string">"INT32"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span><span class="token punctuation">,</span> |
| <span class="token string">"RLE"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span><span class="token punctuation">,</span> |
| <span class="token string">"SNAPPY"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token null keyword">null</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Count timeseries</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"count timeseries root.**"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">4</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Count nodes</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"count nodes root.** level=2"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">4</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show devices</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show devices"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"devices"</span><span class="token punctuation">,</span> |
| <span class="token string">"isAligned"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"false"</span><span class="token punctuation">,</span> |
| <span class="token string">"false"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Show devices with database</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"show devices with database"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"devices"</span><span class="token punctuation">,</span> |
| <span class="token string">"database"</span><span class="token punctuation">,</span> |
| <span class="token string">"isAligned"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27"</span><span class="token punctuation">,</span> |
| <span class="token string">"root.sg28"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"false"</span><span class="token punctuation">,</span> |
| <span class="token string">"false"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>List user</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"list user"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"user"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Aggregation</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select count(*) from root.sg27"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count(root.sg27.s3)"</span><span class="token punctuation">,</span> |
| <span class="token string">"count(root.sg27.s4)"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token number">0</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">1</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">2</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Group by level</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select count(*) from root.** group by level = 1"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count(root.sg27.*)"</span><span class="token punctuation">,</span> |
| <span class="token string">"count(root.sg28.*)"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">3</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">3</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Group by</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select count(*) from root.sg27 group by([1635232143960,1635232153960),1s)"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"count(root.sg27.s3)"</span><span class="token punctuation">,</span> |
| <span class="token string">"count(root.sg27.s4)"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token number">1635232143960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232144960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232145960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232146960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232147960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232148960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232149960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232150960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232151960</span><span class="token punctuation">,</span> |
| <span class="token number">1635232152960</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">1</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token number">1</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span><span class="token punctuation">,</span> |
| <span class="token number">0</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Last</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select last s3 from root.sg27"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"expressions"</span><span class="token operator">:</span> <span class="token null keyword">null</span><span class="token punctuation">,</span> |
| <span class="token property">"column_names"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token string">"timeseries"</span><span class="token punctuation">,</span> |
| <span class="token string">"value"</span><span class="token punctuation">,</span> |
| <span class="token string">"dataType"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"timestamps"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token number">1635232143960</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"root.sg27.s3"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"11"</span> |
| <span class="token punctuation">]</span><span class="token punctuation">,</span> |
| <span class="token punctuation">[</span> |
| <span class="token string">"INT32"</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">]</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Disable align</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select * from root.sg27 disable align"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">407</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"disable align clauses are not supported."</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Align by device</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select count(s3) from root.sg27 align by device"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">407</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"align by device clauses are not supported."</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p><strong>Select into</strong></p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"select s3, s4 into root.sg29.s1, root.sg29.s2 from root.sg27"}'</span> http://127.0.0.1:18080/rest/v2/query |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-json line-numbers-mode" data-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">407</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"select into clauses are not supported."</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><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>`,69),k={href:"http://ip",target:"_blank",rel:"noopener noreferrer"},b=a(`<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-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"sql":"CREATE DATABASE root.ln"}'</span> http://127.0.0.1:18080/rest/v2/nonQuery |
| </code></pre><div class="line-numbers" aria-hidden="true"><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-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">200</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"SUCCESS_STATUS"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="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>`,11),g={href:"http://ip",target:"_blank",rel:"noopener noreferrer"},q=a(`<p>Parameter Description:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">is required</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">timestamps</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Time column</td></tr><tr><td style="text-align:left;">measurements</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The name of the measuring point</td></tr><tr><td style="text-align:left;">data_types</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The data type</td></tr><tr><td style="text-align:left;">values</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Value columns, the values in each column can be <code>null</code></td></tr><tr><td style="text-align:left;">is_aligned</td><td style="text-align:left;">boolean</td><td style="text-align:left;">yes</td><td style="text-align:left;">Whether to align the timeseries</td></tr><tr><td style="text-align:left;">device</td><td style="text-align:left;">string</td><td style="text-align:left;">yes</td><td style="text-align:left;">Device name</td></tr></tbody></table><p>Example request:</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"timestamps":[1635232143960,1635232153960],"measurements":["s3","s4"],"data_types":["INT32","BOOLEAN"],"values":[[11,null],[false,true]],"is_aligned":false,"device":"root.sg27"}'</span> http://127.0.0.1:18080/rest/v2/insertTablet |
| </code></pre><div class="line-numbers" aria-hidden="true"><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-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">200</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"SUCCESS_STATUS"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="insertrecords" tabindex="-1"><a class="header-anchor" href="#insertrecords"><span>insertRecords</span></a></h3><p>Request method: <code>POST</code></p><p>Request header: <code>application/json</code></p>`,11),h={href:"http://ip",target:"_blank",rel:"noopener noreferrer"},y=a(`<p>Parameter Description:</p><table><thead><tr><th style="text-align:left;">parameter name</th><th style="text-align:left;">parameter type</th><th style="text-align:left;">is required</th><th style="text-align:left;">parameter describe</th></tr></thead><tbody><tr><td style="text-align:left;">timestamps</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Time column</td></tr><tr><td style="text-align:left;">measurements_list</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The name of the measuring point</td></tr><tr><td style="text-align:left;">data_types_list</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">The data type</td></tr><tr><td style="text-align:left;">values_list</td><td style="text-align:left;">array</td><td style="text-align:left;">yes</td><td style="text-align:left;">Value columns, the values in each column can be <code>null</code></td></tr><tr><td style="text-align:left;">devices</td><td style="text-align:left;">string</td><td style="text-align:left;">yes</td><td style="text-align:left;">Device name</td></tr><tr><td style="text-align:left;">is_aligned</td><td style="text-align:left;">boolean</td><td style="text-align:left;">yes</td><td style="text-align:left;">Whether to align the timeseries</td></tr></tbody></table><p>Example request:</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">curl</span> <span class="token parameter variable">-H</span> <span class="token string">"Content-Type:application/json"</span> <span class="token parameter variable">-H</span> <span class="token string">"Authorization:Basic cm9vdDpyb290"</span> <span class="token parameter variable">-X</span> POST <span class="token parameter variable">--data</span> <span class="token string">'{"timestamps":[1635232113960,1635232151960,1635232143960,1635232143960],"measurements_list":[["s33","s44"],["s55","s66"],["s77","s88"],["s771","s881"]],"data_types_list":[["INT32","INT64"],["FLOAT","DOUBLE"],["FLOAT","DOUBLE"],["BOOLEAN","TEXT"]],"values_list":[[1,11],[2.1,2],[4,6],[false,"cccccc"]],"is_aligned":false,"devices":["root.s1","root.s1","root.s1","root.s3"]}'</span> http://127.0.0.1:18080/rest/v2/insertRecords |
| </code></pre><div class="line-numbers" aria-hidden="true"><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-ext="json" data-title="json"><pre class="language-json"><code><span class="token punctuation">{</span> |
| <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">200</span><span class="token punctuation">,</span> |
| <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"SUCCESS_STATUS"</span> |
| <span class="token punctuation">}</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="configuration" tabindex="-1"><a class="header-anchor" href="#configuration"><span>Configuration</span></a></h2><p>The configuration is located in 'iotdb-datanode.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-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">enable_rest_service</span><span class="token punctuation">=</span><span class="token value attr-value">true</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>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-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">rest_service_port</span><span class="token punctuation">=</span><span class="token value attr-value">18080</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>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-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">enable_swagger</span><span class="token punctuation">=</span><span class="token value attr-value">false</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>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-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">rest_query_default_row_size_limit</span><span class="token punctuation">=</span><span class="token value attr-value">10000</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>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-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">cache_expire</span><span class="token punctuation">=</span><span class="token value attr-value">28800</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>Maximum number of users stored in the cache (default: 100)</li></ul><div class="language-properties line-numbers-mode" data-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">cache_max_num</span><span class="token punctuation">=</span><span class="token value attr-value">100</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>Initial cache size (default: 10)</li></ul><div class="language-properties line-numbers-mode" data-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">cache_init_num</span><span class="token punctuation">=</span><span class="token value attr-value">10</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>REST Service 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-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">enable_https</span><span class="token punctuation">=</span><span class="token value attr-value">false</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>keyStore location path (optional)</li></ul><div class="language-properties line-numbers-mode" data-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">key_store_path</span><span class="token punctuation">=</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>keyStore password (optional)</li></ul><div class="language-properties line-numbers-mode" data-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">key_store_pwd</span><span class="token punctuation">=</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>trustStore location path (optional)</li></ul><div class="language-properties line-numbers-mode" data-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">trust_store_path</span><span class="token punctuation">=</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>trustStore password (optional)</li></ul><div class="language-properties line-numbers-mode" data-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">trust_store_pwd</span><span class="token punctuation">=</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>SSL timeout period, in seconds</li></ul><div class="language-properties line-numbers-mode" data-ext="properties" data-title="properties"><pre class="language-properties"><code><span class="token key attr-name">idle_timeout</span><span class="token punctuation">=</span><span class="token value attr-value">5000</span> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div>`,36);function f(x,T){const e=o("ExternalLinkIcon");return p(),i("div",null,[r,s("p",null,[n("Request path: "),s("a",c,[n("http://ip"),t(e)]),n(":port/ping")]),d,s("p",null,[n("Request path: "),s("a",v,[n("http://ip"),t(e)]),n(":port/rest/v2/query")]),m,s("p",null,[n("Request path: "),s("a",k,[n("http://ip"),t(e)]),n(":port/rest/v2/nonQuery")]),b,s("p",null,[n("Request path: "),s("a",g,[n("http://ip"),t(e)]),n(":port/rest/v2/insertTablet")]),q,s("p",null,[n("Request path: "),s("a",h,[n("http://ip"),t(e)]),n(":port/rest/v2/insertRecords")]),y])}const S=l(u,[["render",f],["__file","RestServiceV2.html.vue"]]),_=JSON.parse(`{"path":"/UserGuide/latest/API/RestServiceV2.html","title":"RESTful Services","lang":"en-US","frontmatter":{"description":"RESTful Services IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks. Enabl...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://iotdb.apache.org/zh/UserGuide/latest/API/RestServiceV2.html"}],["meta",{"property":"og:url","content":"https://iotdb.apache.org/UserGuide/latest/API/RestServiceV2.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"RESTful Services"}],["meta",{"property":"og:description","content":"RESTful Services IoTDB's RESTful services can be used for query, write, and management operations, using the OpenAPI standard to define interfaces and generate frameworks. Enabl..."}],["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-02-02T03:31:29.000Z"}],["meta",{"property":"article:modified_time","content":"2024-02-02T03:31:29.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"RESTful Services\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2024-02-02T03:31:29.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":3,"title":"insertRecords","slug":"insertrecords","link":"#insertrecords","children":[]}]},{"level":2,"title":"Configuration","slug":"configuration","link":"#configuration","children":[]}],"git":{"createdTime":1688958677000,"updatedTime":1706844689000,"contributors":[{"name":"CritasWang","email":"critas@outlook.com","commits":1},{"name":"wanghui42","email":"105700158+wanghui42@users.noreply.github.com","commits":1}]},"readingTime":{"minutes":6.66,"words":1998},"filePathRelative":"UserGuide/latest/API/RestServiceV2.md","localizedDate":"July 10, 2023","autoDesc":true}`);export{S as comp,_ as data}; |
