56-wsapi-task.html
14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="zh-CN" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="zh-CN" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>20. ws_任务管理接口 — 配置服务接口文档 1.0.0 文档</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="搜索" href="search.html" />
<link rel="next" title="21. ws_子任务管理接口" href="57-wsapi-subtask.html" />
<link rel="prev" title="19. 测试框架(test_framework)" href="92-test_framework.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> 配置服务接口文档
</a>
<div class="version">
1.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">目录:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="10-summary.html">1. 概述</a></li>
<li class="toctree-l1"><a class="reference internal" href="40-api-ws-manager.html">2. 和管理服务之间的Websocket接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="41-api-ws-config.html">3. 运维Websocket接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="42-api-ws-task.html">4. 任务相关Websocket接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="43-api-ws-dome-camera.html">5. 球机相关websocket接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="45-api-ws-video.html">6. 视频通道相关websocket接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="50-api-data-sender.html">7. 数据推送服务接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="web/51-web-api-summary.html">8. web_接口总结</a></li>
<li class="toctree-l1"><a class="reference internal" href="web/52-api-http-get_url.html">9. 获取ws连接地址的接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="web/55-web-api-common.html">10. web_通用接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="web/56-web-api-tasks.html">11. web_任务相关的管理接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="web/57-web-api-subtask.html">12. web_子任务管理接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="web/60-web-api-show-result.html">13. web_任务结果展示</a></li>
<li class="toctree-l1"><a class="reference internal" href="web/61-web-api-resources.html">14. web_资源管理</a></li>
<li class="toctree-l1"><a class="reference internal" href="web/65-web-api-operation.html">15. web_运维接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="70-callback.html">16. 任务回调相关http接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="database.html">17. 数据库设计</a></li>
<li class="toctree-l1"><a class="reference internal" href="91-algo_comb.html">18. 算法组合(algo_comb)</a></li>
<li class="toctree-l1"><a class="reference internal" href="92-test_framework.html">19. 测试框架(test_framework)</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">20. ws_任务管理接口</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id1">20.1. 删除任务</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">20.2. 配置图片任务</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">20.3. 修改存储配置(即替换)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="57-wsapi-subtask.html">21. ws_子任务管理接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="61-wsapi-vchan.html">22. ws_视频通道管理</a></li>
<li class="toctree-l1"><a class="reference internal" href="65-wsapi-operation.html">23. ws_运维接口</a></li>
<li class="toctree-l1"><a class="reference internal" href="99-history.html">24. 修订历史</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">配置服务接口文档</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>20. ws_任务管理接口</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/56-wsapi-task.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="ws">
<h1>20. ws_任务管理接口<a class="headerlink" href="#ws" title="永久链接至标题">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">注解</p>
<ul class="last simple">
<li>本章内容和11. web_任务相关的管理接口对应，区别是由http改为websocket协议。</li>
<li>增加本章接口的目的是解决请求不能立即响应的问题，ws请求将进一步下发到设备，在设备给出响应后再返回。</li>
<li>本接口请求由客户端向设备配置服务发起。</li>
</ul>
</div>
<div class="section" id="id1">
<h2>20.1. 删除任务<a class="headerlink" href="#id1" title="永久链接至标题">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">Request</span> <span class="pre">Body</span></code>:</p>
<blockquote>
<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"command"</span><span class="p">:</span> <span class="s2">"delete /wsapi/v1/devconf_fx/tasks"</span><span class="p">,</span>
<span class="s2">"src_page"</span><span class="p">:</span> <span class="s2">"xxxx"</span><span class="p">,</span>
<span class="s2">"params"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"task_id"</span><span class="p">:</span><span class="s2">"xxx"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">Response</span></code>: 标准响应。</p>
<div class="admonition attention">
<p class="first admonition-title">注意</p>
<p class="last">注意：当任务下存在子任务时，删除会失败。</p>
</div>
</div>
<div class="section" id="id2">
<h2>20.2. 配置图片任务<a class="headerlink" href="#id2" title="永久链接至标题">¶</a></h2>
<div class="admonition attention">
<p class="first admonition-title">注意</p>
<p class="last">本组接口只能用于图片任务，不能用于视频任务。</p>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Request</span> <span class="pre">Body</span></code>:</p>
<blockquote>
<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"command"</span><span class="p">:</span> <span class="s2">"post /wsapi/v1/devconf_fx/tasks/pic_task_config"</span><span class="p">,</span>
<span class="s2">"src_page"</span><span class="p">:</span> <span class="s2">"xxxx"</span><span class="p">,</span>
<span class="s2">"params"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"task_id"</span><span class="p">:</span><span class="s2">"xxx"</span><span class="p">,</span>
<span class="c1"># 以下内容参见11.1.6. 配置图片任务的请求部分</span>
<span class="o">...</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">Response</span></code>:</p>
<blockquote>
<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="c1"># 以下内容参见11.1.6. 配置图片任务的响应部分</span>
<span class="o">...</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<div class="admonition attention">
<p class="first admonition-title">注意</p>
<ol class="last arabic simple">
<li>只能修改图片任务的算法组合配置。</li>
<li>配置完成后将直接下发给设备。</li>
</ol>
</div>
</div>
<div class="section" id="id3">
<h2>20.3. 修改存储配置(即替换)<a class="headerlink" href="#id3" title="永久链接至标题">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">注解</p>
<ul class="last simple">
<li>平台在收到本请求后，要把新的存储配置下发给该大任务下的所有子任务(调用“4.1.2. 修改任务”接口)，并等待设备端确认收到。</li>
<li>由于平台是替换操作，因此不会保存被替换的配置文件，所以无论设备端是否成功修改配置，平台端只要下发成功就认为成功。这就要求设备端能有机制确保配置成功。</li>
</ul>
</div>
<p><code class="docutils literal notranslate"><span class="pre">Request</span> <span class="pre">Body</span></code>:</p>
<blockquote>
<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"command"</span><span class="p">:</span> <span class="s2">"put /wsapi/v1/devconf_fx/store_confs"</span><span class="p">,</span>
<span class="s2">"src_page"</span><span class="p">:</span> <span class="s2">"xxxx"</span><span class="p">,</span>
<span class="s2">"params"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"unid"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span> <span class="c1"># 存储配置的unid</span>
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"xxxx"</span><span class="p">,</span> <span class="c1"># 存储配置的名称</span>
<span class="s2">"file_ext"</span><span class="p">:</span> <span class="s2">"xml"</span><span class="p">,</span> <span class="c1"># 文件扩展名</span>
<span class="s2">"file_b64"</span><span class="p">:</span> <span class="s2">"xxxx"</span> <span class="c1"># base64编码的配置文件内容</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
<p><code class="docutils literal notranslate"><span class="pre">Response</span> <span class="pre">Body</span></code>: 标准响应</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="57-wsapi-subtask.html" class="btn btn-neutral float-right" title="21. ws_子任务管理接口" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="92-test_framework.html" class="btn btn-neutral" title="19. 测试框架(test_framework)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, ldd.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.0.0',
LANGUAGE:'zh_CN',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/translations.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>