HTQ


添加队列

<p><strong>请求URL:</strong> </p> <ul> <li><code>http://server:5999/api/addQueue</code></li> </ul> <p><strong>请求方式:</strong></p> <ul> <li>POST </li> </ul> <p><strong>参数:</strong> </p> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">queue_name</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>队列名,英文+数字,不要出现中文</td> </tr> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>类型。可以是&quot;real_time&quot;、&quot;timing&quot;、&quot;variable&quot; ,分别对应实时队列、定时队列、可变队列。如果是可变队列,则会对执行任务的返回结果有要求。请参考添加任务接口的备注说明部分</td> </tr> <tr> <td style="text-align: left;">app_key</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>请填写config.json里的app_key以供认证。初次安装HTQ可更改默认的值以提高安全性。更改后需要重启HTQ以生效</td> </tr> <tr> <td style="text-align: left;">app_token</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>请填写config.json里的app_token以供认证。初次安装HTQ可更改默认的值以提高安全性。更改后需要重启HTQ以生效</td> </tr> <tr> <td style="text-align: left;">stepping_time</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>步进时间,单位是秒。当队列类型是可变队列的时候请传此参数。可变队列的执行机制请参考下文的备注部分。了解执行机制能让你更清晰地知道该如何设置此值</td> </tr> <tr> <td style="text-align: left;">max_time_interval</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>最大时间间隔,当队列类型是可变队列的时候请传此参数。可变队列的执行机制请参考下文的备注部分 。了解执行机制能让你更清晰地知道该如何设置此值</td> </tr> </tbody> </table> <p><strong>成功返回示例</strong></p> <pre><code>{ &amp;quot;error_code&amp;quot; : 0, &amp;quot;message&amp;quot; : &amp;quot;添加成功&amp;quot; } </code></pre> <p><strong>失败返回示例</strong></p> <pre><code>{ &amp;quot;error_code&amp;quot; : 1000, &amp;quot;message&amp;quot; : &amp;quot;认证失败&amp;quot; } </code></pre> <p><strong>可变队列的执行机制</strong></p> <p>可变队列的某个任务进入队列后,其url会被触发访问。URL执行的页面若返回字符串&quot;reset&quot;( 即直接在url的页面打印&quot;reset&quot;,如命令 print(&quot;reset&quot;) ),则任务的执行时间间隔会重置。若返回字符串&quot;done&quot;,则结束并删除当前任务.其他情况,URl都会被延迟下一次执行。延迟的时间计算公式是:执行次数 X 步进时间(stepping_time) 。其中,延迟时间最大值为max_time_interval。</p> <p>所以,当URl没有被重置或者结束的时候,它会慢慢地增大下次执行时间,变得越来越慢,最后达到最大间隔时间max_time_interval后将一直保持这个执行时间间隔。直至得到重置命令或者结束命令.</p>

页面列表

ITEM_HTML