yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
bf0249500a5ed7b17b83a0aff94fb5d48195ebc7
doc-exports/docs/dcs/api-ref/ShowJobInfo.html
chenjunjie 63188fad94 DCS API 20240705 version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: chenjunjie <chenjunjie@huawei.com>
Co-committed-by: chenjunjie <chenjunjie@huawei.com>
2025-03-17 15:42:06 +00:00

339 lines
23 KiB
HTML
Raw Blame History

<a name="ShowJobInfo"></a><a name="ShowJobInfo"></a>
<h1 class="topictitle1">Querying the Job Execution Result of a Tenant</h1>
<div id="body1708331107508"><div class="section" id="ShowJobInfo__section1823216213562"><h4 class="sectiontitle">Function</h4><p id="ShowJobInfo__p9232152125615">This API is used to query the task execution result.</p>
</div>
<div class="section" id="ShowJobInfo__section223213219562"><h4 class="sectiontitle">URI</h4><p id="ShowJobInfo__p142333225618">GET /v2/{project_id}/jobs/{job_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobInfo__table423312285611" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowJobInfo__row523313215613"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowJobInfo__p14233112175610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowJobInfo__p823322125617">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowJobInfo__p923320214568">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowJobInfo__p1123319212568">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowJobInfo__row1123311219567"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowJobInfo__p1323417255610">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowJobInfo__p523414216567">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowJobInfo__p192343235610">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowJobInfo__p1234182115619">Project ID. For details, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="ShowJobInfo__row1623311215568"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowJobInfo__p162341728564">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowJobInfo__p22342255616">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowJobInfo__p14234142195616">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowJobInfo__p1823412213564">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowJobInfo__section523414225618"><h4 class="sectiontitle">Request Parameters</h4><p id="ShowJobInfo__p32340212562">None</p>
</div>
<div class="section" id="ShowJobInfo__section1823412115617"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowJobInfo__p1323411220563"><strong id="ShowJobInfo__b023442155610">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobInfo__response_ShowJobInfoResp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ShowJobInfo__row82344265619"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowJobInfo__p152355210565">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowJobInfo__p22355214565">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowJobInfo__p623512195618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowJobInfo__row1723413275617"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowJobInfo__p18235182125616">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowJobInfo__p11235142115613">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowJobInfo__p423512214567">Task ID.</p>
</td>
</tr>
<tr id="ShowJobInfo__row13234202195616"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowJobInfo__p323514295616">job_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowJobInfo__p5235112115615">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowJobInfo__p1523513212565">Job type. Options:</p>
<ul id="ShowJobInfo__ul2023512214566"><li id="ShowJobInfo__li1223513255617"><strong id="ShowJobInfo__b92351023563">masterStandbySwapJob</strong>: switching master and standby nodes</li><li id="ShowJobInfo__li1623516285616"><strong id="ShowJobInfo__b723515215615">modifyClientIpTransJob</strong>: modifying source IP pass-through</li></ul>
</td>
</tr>
<tr id="ShowJobInfo__row2023482155614"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowJobInfo__p92364215615">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowJobInfo__p423682195616">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowJobInfo__p9236229562">Job status. Enumeration values:</p>
<ul id="ShowJobInfo__ul0640104865716"><li id="ShowJobInfo__li5640114805720"><strong id="ShowJobInfo__b1964016488575">INIT</strong></li><li id="ShowJobInfo__li16640114815577"><strong id="ShowJobInfo__b16640184816578">RUNNING</strong></li><li id="ShowJobInfo__li1464010481573"><strong id="ShowJobInfo__b1264094811572">SUCCESS</strong></li><li id="ShowJobInfo__li264004845716"><strong id="ShowJobInfo__b18640114816576">FAIL</strong></li></ul>
</td>
</tr>
<tr id="ShowJobInfo__row192342225619"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowJobInfo__p1423632155610">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowJobInfo__p62361213565">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowJobInfo__p172361213560">Job start timestamp, in ms. The format is 1684191545379.</p>
</td>
</tr>
<tr id="ShowJobInfo__row16234328564"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowJobInfo__p1523692185616">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowJobInfo__p423618218562">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowJobInfo__p1823615225613">Job start timestamp, in ms. The format is 1684191548248.</p>
</td>
</tr>
<tr id="ShowJobInfo__row10235627562"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowJobInfo__p02363214561">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowJobInfo__p1923611219568">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowJobInfo__p7236428568">Failure cause.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowJobInfo__p42361826564"><strong id="ShowJobInfo__b12361725565">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobInfo__response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowJobInfo__row123617217569"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowJobInfo__p1023713217568">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowJobInfo__p4237429566">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowJobInfo__p6237192135617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowJobInfo__row92364212566"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowJobInfo__p172379235619">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowJobInfo__p19237824563">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowJobInfo__p1923719205613">Error message.</p>
</td>
</tr>
<tr id="ShowJobInfo__row112365265611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowJobInfo__p1623718255618">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowJobInfo__p192372218563">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowJobInfo__p4237422560">Error code.</p>
</td>
</tr>
<tr id="ShowJobInfo__row7236927560"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowJobInfo__p7237323564">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowJobInfo__p42371225612">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowJobInfo__p2237522564">Extended error information. This parameter is not used currently and is set to <strong id="ShowJobInfo__b4237126561">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowJobInfo__p202371205614"><strong id="ShowJobInfo__b72371226568">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobInfo__table8237926562" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowJobInfo__row152381622568"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="ShowJobInfo__p1123812215565">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="ShowJobInfo__p14238152155612">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="ShowJobInfo__p13238923569">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowJobInfo__row152381125566"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowJobInfo__p923892125617">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowJobInfo__p152387213568">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowJobInfo__p152380215620">Error message.</p>
</td>
</tr>
<tr id="ShowJobInfo__row923882185615"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowJobInfo__p923816235611">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowJobInfo__p1823815215567">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowJobInfo__p162381214562">Error code.</p>
</td>
</tr>
<tr id="ShowJobInfo__row1123811285612"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowJobInfo__p8238428563">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowJobInfo__p182381224560">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowJobInfo__p423912235611">Extended error information. This parameter is not used currently and is set to <strong id="ShowJobInfo__b32397216566">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowJobInfo__p1423912245613"><strong id="ShowJobInfo__b172399215563">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobInfo__table162391326562" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ShowJobInfo__row202397285616"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="ShowJobInfo__p1323972125616">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="ShowJobInfo__p12395205614">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="ShowJobInfo__p1423972115613">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowJobInfo__row623919215562"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowJobInfo__p182399217565">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowJobInfo__p02390215565">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowJobInfo__p172395225618">Error message.</p>
</td>
</tr>
<tr id="ShowJobInfo__row92397211563"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowJobInfo__p123918211565">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowJobInfo__p1023911295617">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowJobInfo__p112398265617">Error code.</p>
</td>
</tr>
<tr id="ShowJobInfo__row0239429568"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="ShowJobInfo__p13239152185619">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="ShowJobInfo__p18240127568">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="ShowJobInfo__p1724013219561">Extended error information. This parameter is not used currently and is set to <strong id="ShowJobInfo__b1924019216564">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowJobInfo__p1824072185617"><strong id="ShowJobInfo__b1524016211565">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobInfo__table172408212562" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ShowJobInfo__row1324011210565"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.1"><p id="ShowJobInfo__p10240122125618">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.2"><p id="ShowJobInfo__p102401321564">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.11.2.4.1.3"><p id="ShowJobInfo__p13240152105620">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowJobInfo__row14240827565"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowJobInfo__p102408214563">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowJobInfo__p12240224569">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowJobInfo__p13240329569">Error message.</p>
</td>
</tr>
<tr id="ShowJobInfo__row19240724568"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowJobInfo__p724012217565">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowJobInfo__p13240524561">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowJobInfo__p724115215616">Error code.</p>
</td>
</tr>
<tr id="ShowJobInfo__row92404214563"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="ShowJobInfo__p192416285612">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="ShowJobInfo__p124132175619">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="ShowJobInfo__p42411226567">Extended error information. This parameter is not used currently and is set to <strong id="ShowJobInfo__b1124110265614">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowJobInfo__p7241424566"><strong id="ShowJobInfo__b15241182115614">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobInfo__table142411220569" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ShowJobInfo__row122411222568"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.13.2.4.1.1"><p id="ShowJobInfo__p924116216569">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.13.2.4.1.2"><p id="ShowJobInfo__p2024110275616">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.13.2.4.1.3"><p id="ShowJobInfo__p824212217566">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowJobInfo__row4241202125611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowJobInfo__p13242162135612">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowJobInfo__p224282175612">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowJobInfo__p1924219210565">Error message.</p>
</td>
</tr>
<tr id="ShowJobInfo__row1241327563"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowJobInfo__p1324202205610">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowJobInfo__p1124218245619">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowJobInfo__p13242172125617">Error code.</p>
</td>
</tr>
<tr id="ShowJobInfo__row82411126567"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.1 "><p id="ShowJobInfo__p1124210218567">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.2 "><p id="ShowJobInfo__p8242192195610">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.13.2.4.1.3 "><p id="ShowJobInfo__p524212145612">Extended error information. This parameter is not used currently and is set to <strong id="ShowJobInfo__b82421729568">null</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowJobInfo__section92421725560"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ShowJobInfo__screen182421423564">GET https://{dcs_endpoint}/v2/a4d31cb6-3d72-4fdc-8ec9-6e3a41e47f71/instances/5560df16-cebf-4473-95c4-d1b573c16e79/tasks/8abf6e1e72c12e7c0172c15b508500aa/progress</pre>
</div>
<div class="section" id="ShowJobInfo__section124212265611"><h4 class="sectiontitle">Example Responses</h4><p id="ShowJobInfo__p524216210563"><strong id="ShowJobInfo__b1524210265620">Status code: 200</strong></p>
<p id="ShowJobInfo__p1924212295619">Details of the background task queried successfully.</p>
<pre class="screen" id="ShowJobInfo__screen1324242115616">{
"job_id" : "ff8080818822bbf70188235afc24141a",
"job_type" : "masterStandbySwapJob",
"status" : "SUCCESS",
"begin_time" : "1684191545379",
"end_time" : "1684191548248",
"fail_reason" : null
}</pre>
<p id="ShowJobInfo__p152439255613"><strong id="ShowJobInfo__b1224316217569">Status code: 400</strong></p>
<p id="ShowJobInfo__p324312125617">Invalid request.</p>
<pre class="screen" id="ShowJobInfo__screen524392145613">{
"error_code" : "111400063",
"error_msg" : "Invalid {0} parameter in the request."
}</pre>
</div>
<div class="section" id="ShowJobInfo__section52431225564"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobInfo__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowJobInfo__row424318215561"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowJobInfo__p624318215618">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowJobInfo__p132436213563">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowJobInfo__row12243523568"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowJobInfo__p624419265616">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowJobInfo__p1924415211565">Details of the background task queried successfully.</p>
</td>
</tr>
<tr id="ShowJobInfo__row124312245617"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowJobInfo__p5244102135611">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowJobInfo__p13244182175610">Invalid request.</p>
</td>
</tr>
<tr id="ShowJobInfo__row15243192105611"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowJobInfo__p424417211567">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowJobInfo__p52444285618">Invalid authentication information.</p>
</td>
</tr>
<tr id="ShowJobInfo__row17243172185615"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowJobInfo__p224412205618">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowJobInfo__p124482115619">Request rejected.</p>
</td>
</tr>
<tr id="ShowJobInfo__row5243429565"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowJobInfo__p1024452165610">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowJobInfo__p11244529561">The requested resource could not be found.</p>
</td>
</tr>
<tr id="ShowJobInfo__row1524316219569"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowJobInfo__p1324416218566">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowJobInfo__p122441129567">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowJobInfo__section19244112115619"><h4 class="sectiontitle">Error Codes</h4><p id="ShowJobInfo__p32448213567">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="BackgroudTasksManagement.html">Background Task Management</a></div>
</div>
</div>
View Git Blame Copy Permalink