doc-exports/docs/ecs/api-ref/en-us_topic_0022067714.html
Artem Goncharov 3196b64bfc
move doc sources to other location (#3)
move doc sources to other location

Reviewed-by: OpenTelekomCloud Bot <None>
2022-04-27 16:24:25 +00:00

124 lines
9.2 KiB
HTML

<a name="EN-US_TOPIC_0022067714"></a><a name="EN-US_TOPIC_0022067714"></a>
<h1 class="topictitle1">Responses (Task)</h1>
<div id="body1447902747916"><ul id="EN-US_TOPIC_0022067714__ul1914908011151"><li id="EN-US_TOPIC_0022067714__li3812399911151">Normal response description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022067714__table757167711151" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0022067714__row5251903911151"><th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.1.1.1.1.4.1.1"><p id="EN-US_TOPIC_0022067714__p2618376611151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.1.1.1.1.4.1.2"><p id="EN-US_TOPIC_0022067714__p4051029311151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="69.69696969696969%" id="mcps1.3.1.1.1.1.4.1.3"><p id="EN-US_TOPIC_0022067714__p6010832511151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022067714__row3693617411151"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.1.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022067714__p3904008711151">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.1.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022067714__p813044011151">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.69696969696969%" headers="mcps1.3.1.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022067714__p5458589811151">Specifies the returned task ID after delivering the task. Users can query the task progress using this ID. For how to query the execution status of the task based on the task ID, see <a href="en-us_topic_0022225397.html">Task Status Management</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0022067714__ul2151103611151"><li id="EN-US_TOPIC_0022067714__li5938160411151">Abnormal response description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022067714__table6467239411151" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0022067714__row2581079811151"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0022067714__p1029990211151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0022067714__p2898571411151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="69%" id="mcps1.3.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0022067714__p6614149111151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022067714__row5586052011151"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022067714__p2840824911151">error</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022067714__p1936686411151">Object</p>
</td>
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022067714__p2558244011151">Specifies the returned error message when an error occurs. For details, see <a href="#EN-US_TOPIC_0022067714__table6409189311151">Table 1</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0022067714__table6409189311151"></a><a name="table6409189311151"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022067714__table6409189311151" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="EN-US_TOPIC_0022067714__b842352706193628">error</strong> field structure</caption><thead align="left"><tr id="EN-US_TOPIC_0022067714__row2324327311151"><th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0022067714__p365693111151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0022067714__p2777597711151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="69.3069306930693%" id="mcps1.3.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0022067714__p3526170111151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022067714__row3762550011151"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022067714__p2776668011151">message</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022067714__p3450864111151">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.3069306930693%" headers="mcps1.3.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022067714__p4373654211151">Describes the error message when an error occurs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022067714__row5808456411151"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022067714__p722924311151">code</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022067714__p4869780211151">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.3069306930693%" headers="mcps1.3.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022067714__p5220791411151">Specifies the error code when an error occurs.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022067714__row152703448361"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022067714__p6270164414368">details</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022067714__p1527164413365">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="69.3069306930693%" headers="mcps1.3.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022067714__p6161120143914">Specifies error details.</p>
<p id="EN-US_TOPIC_0022067714__p12711744153618">Error details provide the error code and fault description, facilitating error handling.</p>
<p id="EN-US_TOPIC_0022067714__p1036024715422">This field is optional.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022067714__table13473121174414" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="EN-US_TOPIC_0022067714__b94227585116">details</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0022067714__row1047321116442"><th align="left" class="cellrowborder" valign="top" width="15.841584158415841%" id="mcps1.3.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0022067714__p16841815164410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0022067714__p156848154441">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="69.3069306930693%" id="mcps1.3.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0022067714__p2684915114416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022067714__row154741118449"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0022067714__p20684191534416">message</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0022067714__p136843156446">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.3069306930693%" headers="mcps1.3.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0022067714__p186847153447">Describes the error message when an error occurs.</p>
<p id="EN-US_TOPIC_0022067714__p39751736204614">This field is optional.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022067714__row1747410114445"><td class="cellrowborder" valign="top" width="15.841584158415841%" headers="mcps1.3.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0022067714__p968411574417">code</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0022067714__p268510154449">String</p>
</td>
<td class="cellrowborder" valign="top" width="69.3069306930693%" headers="mcps1.3.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0022067714__p968518151442">Specifies the error code when an error occurs.</p>
<p id="EN-US_TOPIC_0022067714__p940013934613">This field is optional.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0022067714__ul2891536911151"><li id="EN-US_TOPIC_0022067714__li10918411151">Example response<p id="EN-US_TOPIC_0022067714__p98265911151"><a name="EN-US_TOPIC_0022067714__li10918411151"></a><a name="li10918411151"></a>Normal response</p>
<pre class="screen" id="EN-US_TOPIC_0022067714__screen3351794620424">{
"job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
} </pre>
<p id="EN-US_TOPIC_0022067714__p1248652411151"></p>
<p id="EN-US_TOPIC_0022067714__p5602949124412">Abnormal response</p>
<pre class="screen" id="EN-US_TOPIC_0022067714__screen196021249154415">{
"error": {"message": "", "code": XXX,""}
} </pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0022067713.html">Task Request Result</a></div>
</div>
</div>