基地/厂部/产线视图2——OPP版
<p>[TOC]</p>
<h5>简要描述</h5>
<p><a href="https://www.tapd.cn/50722845/markdown_wikis/show/#1150722845001002668" title="需求文档">需求文档</a></p>
<ul>
<li>基地/厂部/产线视图2——OPP版 <code>PMS微服务接口文档</code></li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>https://eplattest.baoiem.com/pmsds/service</code> 测试环境</li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST</li>
</ul>
<p>[========]</p>
<h1>2. 故障设备数量</h1>
<p>统计当前节点下属设备中,存在未闭环工单的设备数量</p>
<hr />
<h3>请求参数说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">serviceId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">微服务Id</td>
</tr>
<tr>
<td style="text-align: left;">resProjectEname</td>
<td style="text-align: left;">是 (固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">项目名称</td>
</tr>
<tr>
<td style="text-align: left;">resAppEname</td>
<td style="text-align: left;">是(固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">应用名称</td>
</tr>
<tr>
<td style="text-align: left;">domainId</td>
<td style="text-align: left;">否(默认查所有管理域)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">管理域Id</td>
</tr>
</tbody>
</table>
<h3>请求参数</h3>
<pre><code>{
"serviceId": "S_AL_RC_001",
"resProjectEname": "iehmpms",
"resAppEname": "pmsal",
"domainId": "500222"
}</code></pre>
<h3>返回示例 说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">响应状态 {1成功, 0失败 }</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">提示信息</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">返回结果</td>
</tr>
<tr>
<td style="text-align: left;">count</td>
<td style="text-align: left;">故障设备数量</td>
</tr>
</tbody>
</table>
<h3>返回示例</h3>
<pre><code>{
"__sys__": {
"msg": "success:domainId 500222",
"traceId": "7f000000011166729381714900000027",
"detailMsg": "",
"msgKey": "",
"status": 1
},
"data": {
"count": 14
},
"__version__": "2.0",
"__blocks__": {}
}</code></pre>
<hr />
<p>[========]</p>
<h1>4. 当前告警设备</h1>
<hr />
<p>统计当前节点下属设备中,存在未闭环报警的设备数量</p>
<h3>请求参数说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">serviceId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">微服务Id</td>
</tr>
<tr>
<td style="text-align: left;">resProjectEname</td>
<td style="text-align: left;">是 (固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">项目名称</td>
</tr>
<tr>
<td style="text-align: left;">resAppEname</td>
<td style="text-align: left;">是(固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">应用名称</td>
</tr>
<tr>
<td style="text-align: left;">domainId</td>
<td style="text-align: left;">否(默认查所有管理域)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">管理域Id</td>
</tr>
</tbody>
</table>
<h3>请求参数</h3>
<pre><code>{
"serviceId": "S_AL_RC_002",
"resProjectEname": "iehmpms",
"resAppEname": "pmsal",
"domainId": "500222"
}</code></pre>
<h3>返回示例 说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">响应状态 {1成功, 0失败 }</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">提示信息</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">返回结果</td>
</tr>
<tr>
<td style="text-align: left;">count</td>
<td style="text-align: left;">未闭环报警的设备数量</td>
</tr>
</tbody>
</table>
<h3>返回示例</h3>
<pre><code>{
"__sys__": {
"msg": "success:domainId 500222",
"traceId": "7f000000011166729455494100000041",
"detailMsg": "",
"msgKey": "",
"status": 1
},
"data": {
"count": 26
},
"__version__": "2.0",
"__blocks__": {}
}</code></pre>
<p>[========]</p>
<h1>6. 未闭环异常总数量</h1>
<hr />
<p>统计当前节点下属设备中,未闭环工单的数量</p>
<h3>请求参数说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">serviceId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">微服务Id</td>
</tr>
<tr>
<td style="text-align: left;">resProjectEname</td>
<td style="text-align: left;">是 (固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">项目名称</td>
</tr>
<tr>
<td style="text-align: left;">resAppEname</td>
<td style="text-align: left;">是(固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">应用名称</td>
</tr>
<tr>
<td style="text-align: left;">domainId</td>
<td style="text-align: left;">否(默认查所有管理域)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">管理域Id</td>
</tr>
</tbody>
</table>
<h2>请求参数</h2>
<pre><code>{
"serviceId": "S_AL_RC_003",
"resProjectEname": "iehmpms",
"resAppEname": "pmsal",
"domainId": "500222"
}</code></pre>
<h3>返回示例 说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">响应状态 {1成功, 0失败 }</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">提示信息</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">返回结果</td>
</tr>
<tr>
<td style="text-align: left;">count</td>
<td style="text-align: left;">未闭环工单的数量</td>
</tr>
</tbody>
</table>
<h3>返回示例</h3>
<pre><code>{
"__sys__": {
"msg": "success:domainId 500222",
"traceId": "7f000000011166729455494100000041",
"detailMsg": "",
"msgKey": "",
"status": 1
},
"data": {
"count": 26
},
"__version__": "2.0",
"__blocks__": {}
}</code></pre>
<p>[========]</p>
<h1>8. 每日告警数</h1>
<hr />
<p>展示最近30天,每天产生的报警数量,以PMS的报警创建时间为准</p>
<h3>请求参数说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">serviceId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">微服务Id</td>
</tr>
<tr>
<td style="text-align: left;">resProjectEname</td>
<td style="text-align: left;">是 (固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">项目名称</td>
</tr>
<tr>
<td style="text-align: left;">resAppEname</td>
<td style="text-align: left;">是(固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">应用名称</td>
</tr>
</tbody>
</table>
<h3>请求参数</h3>
<pre><code>{
"serviceId": "S_AL_RC_004",
"resProjectEname": "iehmpms",
"resAppEname": "pmsal"
}</code></pre>
<h3>返回示例 说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">响应状态 {1成功, 0失败 }</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">提示信息</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">返回结果</td>
</tr>
<tr>
<td style="text-align: left;">date</td>
<td style="text-align: left;">日期</td>
</tr>
<tr>
<td style="text-align: left;">count</td>
<td style="text-align: left;">每日告警数</td>
</tr>
</tbody>
</table>
<h3>返回示例</h3>
<pre><code>{
"__sys__": {
"msg": "success:range default 30 days. [rangeDays=days] Customized configuration query range",
"traceId": "7f000000011166729489617200000044",
"detailMsg": "",
"msgKey": "",
"status": 0
},
"data": [
{
"date": "2022-11-21",
"count": 1
}
],
"__version__": "2.0",
"__blocks__": {}
}</code></pre>
<p>[========]</p>
<h1>12. 告警数量(月)</h1>
<hr />
<p>按当前节点的下级节点统计,当月产生的报警数量(以PMS的报警创建时间为准)</p>
<h3>请求参数说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">serviceId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">微服务Id</td>
</tr>
<tr>
<td style="text-align: left;">resProjectEname</td>
<td style="text-align: left;">是 (固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">项目名称</td>
</tr>
<tr>
<td style="text-align: left;">resAppEname</td>
<td style="text-align: left;">是(固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">应用名称</td>
</tr>
<tr>
<td style="text-align: left;">domainId</td>
<td style="text-align: left;">否(默认查所有管理域)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">管理域Id</td>
</tr>
</tbody>
</table>
<h3>请求参数</h3>
<pre><code>{
"serviceId": "S_AL_RC_005",
"resProjectEname": "iehmpms",
"resAppEname": "pmsal",
"domainId": "500222"
}</code></pre>
<h3>返回示例 说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">响应状态 {1成功, 0失败 }</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">提示信息</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">返回结果</td>
</tr>
<tr>
<td style="text-align: left;">count</td>
<td style="text-align: left;">当月产生的报警数量</td>
</tr>
</tbody>
</table>
<h3>返回示例</h3>
<pre><code>{
"__sys__": {
"msg": "success:domainId 500222",
"traceId": "7f000000011166729516405700000050",
"detailMsg": "",
"msgKey": "",
"status": 1
},
"data": {
"count": 0
},
"__version__": "2.0",
"__blocks__": {}
}</code></pre>
<p>[========]</p>
<h1>13. 诊断次数(月)</h1>
<hr />
<p>按当前节点的下级节点统计,当月诊断的次数(以诊断报告审核通过时间为准)</p>
<h3>请求参数说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">serviceId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">微服务Id</td>
</tr>
<tr>
<td style="text-align: left;">resProjectEname</td>
<td style="text-align: left;">是 (固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">项目名称</td>
</tr>
<tr>
<td style="text-align: left;">resAppEname</td>
<td style="text-align: left;">是(固定格式)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">应用名称</td>
</tr>
<tr>
<td style="text-align: left;">domainId</td>
<td style="text-align: left;">否(默认查所有管理域)</td>
<td style="text-align: left;">string</td>
<td style="text-align: left;">管理域Id</td>
</tr>
</tbody>
</table>
<h3>请求参数</h3>
<pre><code>{
"serviceId": "S_AL_RC_006",
"resProjectEname": "iehmpms",
"resAppEname": "pmsal",
"domainId": "500222"
}</code></pre>
<h3>返回示例 说明</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">参数</th>
<th style="text-align: left;">描述</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">响应状态 {1成功, 0失败 }</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">提示信息</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">返回结果</td>
</tr>
<tr>
<td style="text-align: left;">count</td>
<td style="text-align: left;">当月诊断的次数</td>
</tr>
</tbody>
</table>
<h3>返回示例</h3>
<pre><code>{
"__sys__": {
"msg": "success:domainId 500222",
"traceId": "7f000000011166729554318500000010",
"detailMsg": "",
"msgKey": "",
"status": 1
},
"data": {
"count": 0
},
"__version__": "2.0",
"__blocks__": {}
}</code></pre>