forked from docs/doc-exports
Li, Qiao
c9ede6a90e
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
105 lines
7.9 KiB
HTML
105 lines
7.9 KiB
HTML
<a name="antiddos_02_0022"></a><a name="antiddos_02_0022"></a>
|
|
|
|
<h1 class="topictitle1">Querying Anti-DDoS Tasks</h1>
|
|
<div id="body9192332"><div class="section" id="antiddos_02_0022__section32049974"><h4 class="sectiontitle">Functions</h4><p id="antiddos_02_0022__p6381418">This API enables you to query the execution status of a specified Anti-DDoS configuration task.</p>
|
|
</div>
|
|
<div class="section" id="antiddos_02_0022__section20014316"><h4 class="sectiontitle">URI</h4><ul id="antiddos_02_0022__ul47132853"><li id="antiddos_02_0022__li21542494">URI format<p id="antiddos_02_0022__p08991947155310"><a name="antiddos_02_0022__li21542494"></a><a name="li21542494"></a>GET /v1/{project_id}/query_task_status</p>
|
|
<div class="note" id="antiddos_02_0022__note111607"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="antiddos_02_0022__p1004464">You can use <span class="parmvalue" id="antiddos_02_0022__parmvalue1572956515112859"><b>?</b></span> and <span class="parmvalue" id="antiddos_02_0022__parmvalue941938294112859"><b>&</b></span> behind the URI to add query conditions, as shown in the request example.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
<ul id="antiddos_02_0022__ul9040176"><li id="antiddos_02_0022__li14252720">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0022__table61165617" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0022__row11133117"><th align="left" class="cellrowborder" valign="top" width="19.11191119111911%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="antiddos_02_0022__p29367308">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.06200620062006%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="antiddos_02_0022__p29941743">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.37123712371237%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="antiddos_02_0022__p9362127">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.45484548454845%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="antiddos_02_0022__p20134803">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="antiddos_02_0022__row60087991151245"><td class="cellrowborder" valign="top" width="19.11191119111911%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="antiddos_02_0022__p59638706151259">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.06200620062006%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="antiddos_02_0022__p66005896151259">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.37123712371237%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="antiddos_02_0022__p44877366151259">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.45484548454845%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="antiddos_02_0022__p11188069151259">User ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="antiddos_02_0022__section45911124"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0022__table688625362710" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="antiddos_02_0022__row1088885302714"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.3.2.2.5.1.1"><p id="antiddos_02_0022__p1788925311271">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.12%" id="mcps1.3.3.2.2.5.1.2"><p id="antiddos_02_0022__p1688995317277">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.379999999999999%" id="mcps1.3.3.2.2.5.1.3"><p id="antiddos_02_0022__p889045314271">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.45%" id="mcps1.3.3.2.2.5.1.4"><p id="antiddos_02_0022__p8891135312272">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="antiddos_02_0022__row1089585352717"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.2.2.5.1.1 "><p id="antiddos_02_0022__p17896953172711">task_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.12%" headers="mcps1.3.3.2.2.5.1.2 "><p id="antiddos_02_0022__p589615332710">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.379999999999999%" headers="mcps1.3.3.2.2.5.1.3 "><p id="antiddos_02_0022__p1689795313275">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="antiddos_02_0022__p17898105342710">Task ID (nonnegative integer) character string</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="antiddos_02_0022__section10546933"><h4 class="sectiontitle">Response</h4><ul id="antiddos_02_0022__ul14055149"><li id="antiddos_02_0022__li59387477">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0022__table64725245" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0022__row61244824"><th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="antiddos_02_0022__p61883722">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.240000000000002%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="antiddos_02_0022__p46525609">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.559999999999995%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="antiddos_02_0022__p10477980">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="antiddos_02_0022__row43410060"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0022__p26553952">task_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0022__p3386497">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><div class="p" id="antiddos_02_0022__p41609089162611">Status of a task, which can be one of the following:<ul id="antiddos_02_0022__ul26350006162615"><li id="antiddos_02_0022__li55844510162646">success</li><li id="antiddos_02_0022__li57211775162648">failed</li><li id="antiddos_02_0022__li48775305162650">waiting</li><li id="antiddos_02_0022__li20240387162615">running</li><li id="antiddos_02_0022__li4383184592739">preprocess</li><li id="antiddos_02_0022__li2595170492733">ready</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="antiddos_02_0022__row52837255"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0022__p51959302">task_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0022__p47953966">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.559999999999995%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0022__p59066022">Additional information about a task</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="antiddos_02_0022__section89594226506"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0022__ul56581830155018"><li id="antiddos_02_0022__li1155961515018">Example request<pre class="codeblock" id="antiddos_02_0022__codeblock113342304561">GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/query_task_status?task_id=4a4fefe7-34a1-40e2-a87c-16932af3ac4a</pre>
|
|
</li></ul>
|
|
<ul id="antiddos_02_0022__ul6984722145017"><li id="antiddos_02_0022__li49844227506">Example response<pre class="screen" id="antiddos_02_0022__screen1498492215016">{
|
|
"task_status": "running",
|
|
"task_msg": ""
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="antiddos_02_0022__section27813538"><h4 class="sectiontitle">Status Code</h4><p id="antiddos_02_0022__p50824621">See <a href="antiddos_02_0031.html">Status Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="antiddos_02_0016.html">Anti-DDoS APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|