You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@iotdb.apache.org by GitBox <gi...@apache.org> on 2021/05/20 08:26:33 UTC
[GitHub] [iotdb] WhiplashFyx edited a comment on issue #3130: IotDB图形化管理监控界面研发计划
WhiplashFyx edited a comment on issue #3130:
URL: https://github.com/apache/iotdb/issues/3130#issuecomment-843767864
<!--StartFragment--><h3 cid="n0" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.5em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.43; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">1.数据库管理</span></h3><figure class="md-table-fig" cid="n4" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(10
0% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
API | 路径 | 方法
-- | -- | --
建立或修改数据库服务器的连接 | /servers | POST
数据库服务器已有连接的删除 | /servers/{serverId} | DELETE
数据库服务器已有连接的查询 | /servers/{serverId} | GET
数据库服务器查询所有已有连接 | /servers | GET
数据库存储组的新增、修改 | /servers/{serverId}/storageGroups | POST
数据库存储组的删除 | /servers/{serverId}//storageGroups/{groupId} | DELETE
查询所有数据库存储组 | /servers/{serverId}/storageGroups | GET
查询所有数据库存储组设备 | /servers/{serverId}/storageGroups/{groupId}/devices | GET
数据库插入记录 | /servers/{serverId}/storageGroups/{groupId}/records | POST
数据库记录查询 | /servers/{serverId}/storageGroups/{groupId}/records | GET
数据库时间序列创建、修改 | /servers/{serverId}/timeseries | POST
数据库时间序列删除 | /servers/{serverId}/timeseries/{timeseriesId} | DELETE
查询所有数据库时间序列 | /servers/{serverId}/timeseries | GET
查询指定的数据库时间序列 | /servers/{serverId}/timeseries/{timeseriesId} | GET
</figure><h4 cid="n25" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">建立或修改数据库服务器的连接</span></h4><p cid="n329" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4;
margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:POST /servers</span></p><p cid="n332" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-
box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">无</span></p><p cid="n334" mdtype="paragraph" class="md-end-block md
-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n388" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
host | String | 主机地址
port | Integer | 端口号
username | String | 用户名
password | String | 密码
alias | String | 连接名,必须唯一
</figure><p cid="n327" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1505" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据,没有数据返回为null
</figure><p cid="n1503" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n606" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库服务器已有连接的删除</span></h4><p cid="n417" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter
-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:DELETE /servers/{serverId}</span></p><p cid="n418" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures
: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n434" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n419" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: borde
r-box; text-indent: 0px;">无</span></p><p cid="n610" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1551" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据,没有数据返回为null
</figure><p cid="n1531" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n366" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库服务器已有连接的查询 </span></h4><p cid="n459" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; lette
r-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:GET /servers/{serverId}</span></p><p cid="n460" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures:
normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n497" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n461" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: borde
r-box; text-indent: 0px;">无</span></p><p cid="n1569" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1692" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | object | 调用后返回的数据
data.host | String | 主机地址
data.port | Integer | 端口号
data.username | String | 用户名
data.password | String | 密码
data.alias | String | 连接名
</figure><p cid="n343" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n1710" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库服务器查询所有已有连接 </span></h4><p cid="n512" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; le
tter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:GET /servers</span></p><p cid="n513" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-vari
ant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">无</span></p><p cid="n514" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-varian
t-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">无</span></p><p cid="n616" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size:
16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1711" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | object | 调用后返回的数据
data.list | array | 调用成功返回已有连接的服务器连接名列表
</figure><p cid="n367" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span></p><!--EndFragment-->
**
```json
{
"list":[
"alias1",
"alias2"
]
}
```
#### 数据库存储组的新增、修改
**请求路径**:POST /servers/{serverId}/storageGroups
**query参数:**
<!--StartFragment--><figure class="md-table-fig" cid="n4816" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n527" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n545" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
groupName | String | 存储组名字
</figure><p cid="n368" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1731" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据
</figure><p cid="n620" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n1749" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库存储组的删除 </span></h4><p cid="n562" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: n
ormal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:DELETE /servers/{serverId}/storageGroups/{groupId}</span></p><p cid="n563" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-vari
ant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n583" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
groupId | String | 存储组名字作为唯一标识
</figure><p cid="n564" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: borde
r-box; text-indent: 0px;">无</span></p><p cid="n1582" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1751" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据
</figure><p cid="n557" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n1769" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">查询所有数据库存储组 </span></h4><p cid="n598" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacin
g: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:GET /servers/{serverId}/storageGroups</span></p><p cid="n599" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: nor
mal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n4753" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n600" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: borde
r-box; text-indent: 0px;">无</span></p><p cid="n1586" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1770" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | object | 调用后返回的数据
data.list | array | 调用成功后返回的存储组列表
</figure><p cid="n369" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-b
ox; text-indent: 0px;">:</span></p><!--EndFragment-->
```json
{
"list":[
"root.demo1",
"root.demo2"
]
}
```
#### 查询所有数据库存储组设备
**请求路径**:GET /servers/{serverId}/storageGroups/{groupId}/devices
**query参数:**
<!--StartFragment--><figure class="md-table-fig" cid="n667" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
groupId | String | 存储组名字作为唯一标识
</figure><p cid="n642" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: borde
r-box; text-indent: 0px;">无</span></p><p cid="n1590" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1790" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | object | 调用后返回的数据
data.list | array | 调用成功后返回的指定存储组的设备列表
</figure><p cid="n370" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-b
ox; text-indent: 0px;">:</span></p><!--EndFragment-->
```json
{
"list":[
"root.demo1.dev1",
"root.demo1.dev2"
]
}
```
#### 数据库插入记录
**请求路径**:POST /servers/{serverId}/storageGroup/{groupId}/records
**query参数:**
<!--StartFragment--><figure class="md-table-fig" cid="n711" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
groupId | String | 存储组名字作为唯一标识
</figure><p cid="n686" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n724" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
deviceId | String | 设备名
time | Long | 时间
measurements | List<String> | 执行的传感器集合
types | List<String> | 对应支持的数据类型;BOOLEAN,INT32,INT64,FLOAT,DOUBLE,TEXT;
values | list<String> | 对应的值
</figure><p cid="n688" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1812" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据
</figure><p cid="n1594" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n372" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库记录查询 </span></h4><p cid="n781" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal
; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:GET /servers/{serverId}/storageGroup/{groupId}/records</span></p><p cid="n782" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-vari
ant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n805" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
groupId | String | 存储组名字作为唯一标识
</figure><p cid="n783" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: borde
r-box; text-indent: 0px;">无</span></p><p cid="n1597" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1831" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | object | 调用后返回的数据
data.list | array | 调用成功后返回的记录列表
</figure><p cid="n373" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-b
ox; text-indent: 0px;">:</span></p><!--EndFragment-->
```json
{
"list":[
{
"time":"2021-05-17T15:21:47.873+08:00",
"value":"test1"
},
{
"time":"2021-05-17T15:22:47.873+08:00",
"value":"test2"
}
]
}
```
#### 数据库时间序列创建、修改
**请求路径**:POST /servers/{serverId}/timeseries
**query参数:**
<!--StartFragment--><figure class="md-table-fig" cid="n4869" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n833" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n858" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 说明
-- | -- | --
path | String | 传感器路径
dataType | String | 数据类型;BOOLEAN,INT32,INT64,FLOAT,DOUBLE,TEXT;
encoding | String | 编码方式;PLAIN,PLAIN_DICTIONARY,RLE,DIFF,TS_2DIFF,BITMAP,GORILLA,REGULAR;
compressionType | String | 压缩方式;UNCOMPRESSED,SNAPPY,GZIP,LZO,SDT,PAA,PLA;
</figure><p cid="n834" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1850" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据
</figure><p cid="n374" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n1868" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库时间序列删除 </span></h4><p cid="n899" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing:
normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:DELETE /servers/{serverId}/timeseries/{timeseriesId}</span></p><p cid="n900" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; fon
t-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n925" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
timeseriesId | String | 时间序列名字作为唯一标识
</figure><p cid="n901" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: borde
r-box; text-indent: 0px;">无</span></p><p cid="n1604" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1869" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据
</figure><p cid="n375" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n1887" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">查询所有数据库时间序列 </span></h4><p cid="n940" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spa
cing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:GET /servers/{serverId}/timeseries</span></p><p cid="n941" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-lig
atures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n4915" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n942" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: borde
r-box; text-indent: 0px;">无</span></p><p cid="n1608" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1891" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | Object | 调用后返回的数据
data.list | array | 调用成功后返回的时间序列列表
</figure><p cid="n947" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-b
ox; text-indent: 0px;">:</span></p><!--EndFragment-->
```json
{
"list":[
{
"timeseries":"root.demo1.dev1.status",
"storageGroup":"root.demo1",
"dataType":"TEXT",
"encoding":"PLAIN",
"compression":"SNAPPY"
},
{
"timeseries":"root.demo1.dev1.temp",
"storageGroup":"root.demo1",
"dataType":"TEXT",
"encoding":"PLAIN",
"compression":"SNAPPY"
}
]
}
```
#### 查询指定的数据库时间序列
**请求路径**:GET /servers/{serverId}/timeseries/{timeseriesId}
**query参数:**
<!--StartFragment--><figure class="md-table-fig" cid="n978" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
timeseriesId | String | 时间序列名字作为唯一标识
</figure><p cid="n961" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: borde
r-box; text-indent: 0px;">无</span></p><p cid="n1612" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1909" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | Object | 调用后返回的数据
data.list | Array | 调用成功后返回的指定时间序列的数据列表
</figure><p cid="n952" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-b
ox; text-indent: 0px;">:</span></p><!--EndFragment-->
```json
{
"list":[
{
"timeseries":"root.demo1.dev1.status",
"storageGroup":"root.demo1",
"dataType":"TEXT",
"encoding":"PLAIN",
"compression":"SNAPPY"
}
]
}
```
### 2.数据库账号管理
<!--StartFragment--><figure class="md-table-fig" cid="n100" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
API | 路径 | 方法
-- | -- | --
数据库用户创建 | /servers/{serverId}/users | POST
数据库用户删除 | /servers/{serverId}/users/{userId} | DELETE
数据库角色创建 | /servers/{serverId}/roles | POST
数据库角色删除 | /servers/{serverId}/roles/{roleId} | DELETE
数据库用户查询所有 | /servers/{serverId}/users | GET
数据库角色查询所有 | /servers/{serverId}/roles | GET
数据库用户权限查询所有 | /servers/{serverId}/users/privileges/{userId} | GET
数据库角色权限查询所有 | /servers/{serverId}/roles/privileges/{roleId} | GET
</figure><h4 cid="n1066" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库用户创建 </span></h4><p cid="n1107" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0
px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">: POST /servers/{serverId}/users</span></p><p cid="n1108" mdtype="paragraph" class="md-end-block md-p md-focus" style="box
-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n4971" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n1109" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1221" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
username | String | 用户名;长度不小于4,不包含空格
password | String | 密码;长度不小于4,不包含空格
privileges | List<String> | 赋予用户的权限集合
</figure><p cid="n1618" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">权限表路径:</span></p><p cid="n1235" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: r
gb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="url" class="md-link" spellcheck="false" style="box-sizing: border-box; word-break: break-all; text-indent: 0px;"><a href="https://iotdb.apache.org/zh/UserGuide/V0.12.x/Administration-Management/Administration.html" style="box-sizing: border-box; cursor: pointer; color: rgb(65, 131, 196); -webkit-user-drag: none; text-indent: 0px;">https://iotdb.apache.org/zh/UserGuide/V0.12.x/Administration-Management/Administration.html</a></span></p><p cid="n1620" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; l
ine-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1927" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据
</figure><p cid="n1094" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n1945" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库用户删除 </span></h4><p cid="n1115" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: norma
l; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:DELETE /servers/{serverId}/users/{userId}</span></p><p cid="n1116" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: nor
mal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1343" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
userId | String | 用户名字作为唯一标识
</figure><p cid="n1117" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: bord
er-box; text-indent: 0px;">无</span></p><p cid="n1624" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1946" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据
</figure><p cid="n1095" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n1964" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库角色创建 </span></h4><p cid="n1123" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: no
rmal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">: POST /servers/{serverId}/roles</span></p><p cid="n1124" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: no
rmal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n5055" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n1125" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1381" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
rolename | String | 用户名;长度不小于4,不包含空格
privileges | List<String> | 赋予用户的权限集合
</figure><p cid="n1127" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1965" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据
</figure><p cid="n1096" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n1983" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库角色删除</span></h4><p cid="n1131" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal
; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:DELETE /servers/{serverId}/roles/{roleId}</span></p><p cid="n1132" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: norma
l; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1425" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
roleId | String | 角色名字作为唯一标识
</figure><p cid="n1133" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: bord
er-box; text-indent: 0px;">无</span></p><p cid="n1418" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1984" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | - | 调用后返回的数据
</figure><p cid="n1097" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h4 cid="n2002" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库用户查询所有</span></h4><p cid="n1146" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing:
normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:GET /servers/{serverId}/users</span></p><p cid="n1147" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: no
rmal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n5104" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n1148" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: bord
er-box; text-indent: 0px;">无</span></p><p cid="n1633" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n2003" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | Object | 调用后返回的数据
data.list | Array | 调用成功后返回的用户列表
</figure><p cid="n1098" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-
box; text-indent: 0px;">:</span></p><!--EndFragment-->
```json
{
"list":[
"root",
"user1"
]
}
```
#### 数据库角色查询所有
**请求路径**:GET /servers/{serverId}/roles
**query参数:**
<!--StartFragment--><figure class="md-table-fig" cid="n5133" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n1154" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: bord
er-box; text-indent: 0px;">无</span></p><p cid="n1637" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n2022" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | Object | 调用后返回的数据
data.list | Array | 调用成功后返回的角色列表
</figure><p cid="n1099" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-
box; text-indent: 0px;">:</span></p><!--EndFragment-->
```json
{
"list":[
"role1",
"role2"
]
}
```
#### 数据库用户权限查询
**请求路径**:GET /servers/{serverId}/users/privileges/{userId}/{path}
**query参数:**
<!--StartFragment--><figure class="md-table-fig" cid="n1459" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
userId | String | 用户名字作为唯一标识
path | String | 指定路径,用于查询用户在此路径下的权限
</figure><p cid="n1166" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: bord
er-box; text-indent: 0px;">无</span></p><p cid="n1645" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n2060" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | Object | 调用后返回的数据
data.list | Array | 调用成功后返回的指定路径下用户的权限
</figure><p cid="n2078" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-
box; text-indent: 0px;">:</span></p><!--EndFragment-->
```json
{
"list":[
{
"role":null,
"privilege":"root.demo1: CREATE_TIMESERIES DELETE_TIMESERIES"
},
{
"role":"role1",
"privilege":"root.demo1: UPDATE_TIMESERIES"
}
]
}
```
#### 所有数据库角色权限查询所有
**请求路径**:GET /servers/{serverId}/roles/privileges/{roleId}/{path}
**query参数:**
<!--StartFragment--><figure class="md-table-fig" cid="n1473" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
roleId | String | 角色名字作为唯一标识
path | String | 指定路径,用于查询角色在此路径下的权限
</figure><p cid="n1172" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: bord
er-box; text-indent: 0px;">无</span></p><p cid="n1650" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n2079" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | Object | 调用后返回的数据
data.list | Array | 调用成功后返回的指定路径下角色的权限
</figure><p cid="n1038" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">data结构</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-
box; text-indent: 0px;">:</span></p><!--EndFragment-->
```json
{
"list":[
{
"privilege":"root.demo1: UPDATE_TIMESERIES"
}
]
}
```
### 3.数据库查询管理
<!--StartFragment--><figure class="md-table-fig" cid="n174" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
API | 路径 | 方法
-- | -- | --
数据库查询编辑器 | /servers/{serverId}/query | POST
</figure><h4 cid="n1006" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">数据库查询编辑器</span></h4><p cid="n999" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0p
x; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:GET /servers/{serverId}/query</span></p><p cid="n994" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizi
ng: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n5179" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
参数名 | 类型 | 说明
-- | -- | --
serverId | String | 连接名alias作为唯一标识
</figure><p cid="n995" mdtype="paragraph" class="md-end-block md-p md-focus" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n1027" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 说明
-- | -- | --
query | String | 查询语句
</figure><p cid="n1653" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">返回参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n2099" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 描述
-- | -- | --
code | String | 调用后返回的状态码;成功为0,失败为-1或已定义的错误码
msg | String | 调用后返回的状态信息
data | Object | 调用后返回的数据,根据查询返回对应的实体数据
</figure><p cid="n5199" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><h3 cid="n5200" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.5em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.43; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51);
font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">4.用户管理</span></h3><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n5215" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
API | 路径 | 方法
-- | -- | --
用户登录 | /login | POST
</figure><h4 cid="n5224" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.25em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.4; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">用户登录</span></h4><p cid="n5229" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-sp
ace: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">请求路径</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">:POST /login</span></p><p cid="n5232" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit;
orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">query参数:</span></strong></span><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">无</span></p><p cid="n5236" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: bo
rder-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">body参数:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n5243" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
参数名 | 类型 | 说明
-- | -- | --
username | String | 用户名
password | String | 密码
</figure><p cid="n5256" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;"> </span><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">�
��回请求头:</span></strong></span></p><!--EndFragment-->
<!--StartFragment--><figure class="md-table-fig" cid="n5293" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><br class="Apple-interchange-newline">
header | 说明
-- | --
Authorization | 由JWT生成,验证用户权限
</figure><p class="md-end-block md-p" mdtype="paragraph" cid="n5204" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="strong" class="" style="box-sizing: border-box; text-indent: 0px;"><strong style="box-sizing: border-box; text-indent: 0px;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">示例:</span></strong></span></p><p cid="n5302" mdtype="paragraph" class="md-end-block md-p" styl
e="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">Authorization = eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MjE0ODAxNzMsInVzZXJJZCI6MjEsInVzZXJuYW1lIjoieGlhbyJ9.HkCC4L7BOl30rpZMMUFrBviej8LqDjxMOjMZMaYxGZs</span></p><!--EndFragment-->
<!--StartFragment--><h3 cid="n5301" mdtype="heading" class="md-end-block md-heading" style="box-sizing: border-box; break-after: avoid-page; break-inside: avoid; orphans: 2; font-size: 1.5em; margin-top: 1rem; margin-bottom: 1rem; position: relative; font-weight: bold; line-height: 1.43; cursor: text; white-space: pre-wrap; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box;">5.API鉴权</span></h3><p cid="n5205" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px
; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"><span md-inline="plain" class="md-plain" style="box-sizing: border-box; text-indent: 0px;">在API调用时需要进行权限校验,故需要在各接口请求头中携带安全鉴权信息。</span></p><figure class="md-table-fig" cid="n5268" mdtype="table" style="box-sizing: border-box; margin: 1.2em 0px; overflow-x: auto; max-width: calc(100% + 16px); padding: 0px; cursor: default; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helveti
ca Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;">
header | 说明
-- | --
Authorization | 由JWT生成,验证用户权限
</figure><p cid="n5264" mdtype="paragraph" class="md-end-block md-p" style="box-sizing: border-box; line-height: inherit; orphans: 4; margin: 0.8em 0px; white-space: pre-wrap; position: relative; text-indent: 2em; color: rgb(51, 51, 51); font-family: "Open Sans", "Clear Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-transform: none; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;"></p><br class="Apple-interchange-newline"><!--EndFragment-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org