lboka/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sdrs/api-ref/sdrs_05_0901.html
Wei, Hongmin ab56d080fb SDRS API initial version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-26 13:51:50 +00:00

380 lines
33 KiB
HTML
Raw Blame History

<a name="sdrs_05_0901"></a><a name="sdrs_05_0901"></a>
<h1 class="topictitle1">Querying Failed Tasks</h1>
<div id="body1548226305273"><div class="section" id="sdrs_05_0901__section778722103515"><h4 class="sectiontitle">Function</h4><p id="sdrs_05_0901__p28135228352">This API is used to query failed tasks of all protection groups or failed tasks in a specified protection group.</p>
</div>
<div class="section" id="sdrs_05_0901__section578752118358"><h4 class="sectiontitle">Constraints and Limitations</h4><p id="sdrs_05_0901__p1981318225351">None</p>
</div>
<div class="section" id="sdrs_05_0901__section1478822113513"><h4 class="sectiontitle">URI</h4><ul id="sdrs_05_0901__ul1881342283517"><li id="sdrs_05_0901__li881317229351">URI format<p id="sdrs_05_0901__p6813922163520"><a name="sdrs_05_0901__li881317229351"></a><a name="li881317229351"></a>GET /v1/{project_id}/task-center/failure-jobs</p>
</li><li id="sdrs_05_0901__li981362212353">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0901__table979182173511" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0901__row148131622173515"><th align="left" class="cellrowborder" valign="top" width="17.528247175282473%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="sdrs_05_0901__p2813132253518"><strong id="sdrs_05_0901__b84235270615443">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.528247175282473%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="sdrs_05_0901__p281362215352"><strong id="sdrs_05_0901__b84235270615447">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.428557144285573%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="sdrs_05_0901__p1081332263518"><strong id="sdrs_05_0901__b84235270615453">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.51494850514948%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="sdrs_05_0901__p19813142220351"><strong id="sdrs_05_0901__b84235270615457">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0901__row581312226353"><td class="cellrowborder" valign="top" width="17.528247175282473%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="sdrs_05_0901__p1813172263520">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.528247175282473%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="sdrs_05_0901__p78131822193520">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.428557144285573%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="sdrs_05_0901__p38131122183510">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.51494850514948%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="sdrs_05_0901__p081332213352">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="sdrs_05_0901__ul664861442311"><li id="sdrs_05_0901__li1264821414236"><strong id="sdrs_05_0901__b178515337915">Request filter</strong> field description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0901__table136481148235" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0901__row1964611148237"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.1.2.1.5.1.1"><p id="sdrs_05_0901__p16646161412313"><strong id="sdrs_05_0901__b1900272691">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.1.2.1.5.1.2"><p id="sdrs_05_0901__p1164610141234"><strong id="sdrs_05_0901__b1387629151">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.1.2.1.5.1.3"><p id="sdrs_05_0901__p86461214202317"><strong id="sdrs_05_0901__b452825256">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.4.1.2.1.5.1.4"><p id="sdrs_05_0901__p3646111412237"><strong id="sdrs_05_0901__b392221647">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0901__row7646111462318"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.1.2.1.5.1.1 "><p id="sdrs_05_0901__p8551101016103">failure_status</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.1.2.1.5.1.2 "><p id="sdrs_05_0901__p6646131411233">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.1.2.1.5.1.3 "><p id="sdrs_05_0901__p96462014202314">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.1.2.1.5.1.4 "><p id="sdrs_05_0901__p346194021018">Query the task failure status.</p>
<ul id="sdrs_05_0901__ul3102418482"><li id="sdrs_05_0901__li1910154104815"><strong id="sdrs_05_0901__b1867214571280">createFail</strong>: indicates a creation failure.</li><li id="sdrs_05_0901__li686712854815"><strong id="sdrs_05_0901__b1374118586433">deleteFail</strong>: indicates a deletion failure.</li><li id="sdrs_05_0901__li1137484314139"><strong id="sdrs_05_0901__b1090518479108">attachFail</strong>: indicates an attachment failure.</li><li id="sdrs_05_0901__li83772434135"><strong id="sdrs_05_0901__b154111810151112">detachFail</strong>: indicates a detachment failure.</li><li id="sdrs_05_0901__li21631944141311"><strong id="sdrs_05_0901__b53861423128">expandFail</strong>: indicates an expansion failure.</li><li id="sdrs_05_0901__li41677442131"><strong id="sdrs_05_0901__b12838194813120">resizeFail</strong>: indicates a specification change failure.</li><li id="sdrs_05_0901__li1796564415136"><strong id="sdrs_05_0901__b1764072612137">startFail</strong>: indicates a protection enabling failure. </li><li id="sdrs_05_0901__li12966144181315"><strong id="sdrs_05_0901__b6745134112133">stopFail</strong>: indicates a protection disabling failure. </li><li id="sdrs_05_0901__li5560847201316"><strong id="sdrs_05_0901__b1112013817149">reverseFail</strong>: indicates a planned failover failure.</li><li id="sdrs_05_0901__li5562184715136"><strong id="sdrs_05_0901__b161043593141">failoverFail</strong>: indicates a failover failure.</li><li id="sdrs_05_0901__li2368134193715"><strong id="sdrs_05_0901__b14297165911110">reprotectFail</strong>: indicates a re-protection enabling failure.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0901__row14647181422313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.1.2.1.5.1.1 "><p id="sdrs_05_0901__p145517105104">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.1.2.1.5.1.2 "><p id="sdrs_05_0901__p20646141482315">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.1.2.1.5.1.3 "><p id="sdrs_05_0901__p96469140238">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.1.2.1.5.1.4 "><p id="sdrs_05_0901__p34614020101">Specifies the resource name of a protection group.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row964781412317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.1.2.1.5.1.1 "><p id="sdrs_05_0901__p05511710131010">server_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.1.2.1.5.1.2 "><p id="sdrs_05_0901__p4647114182312">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.1.2.1.5.1.3 "><p id="sdrs_05_0901__p18647141442317">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.1.2.1.5.1.4 "><p id="sdrs_05_0901__p17248167145112">Specifies the ID of a protection group.</p>
<p id="sdrs_05_0901__p16481833123718">For details, see <a href="sdrs_05_0402.html">Querying Protection Groups</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row26471314102313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.1.2.1.5.1.1 "><p id="sdrs_05_0901__p17551010141015">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.1.2.1.5.1.2 "><p id="sdrs_05_0901__p164717144233">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.1.2.1.5.1.3 "><p id="sdrs_05_0901__p66476149235">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.1.2.1.5.1.4 "><p id="sdrs_05_0901__p13462040111018">Specifies the resource type.</p>
<ul id="sdrs_05_0901__ul10445051171612"><li id="sdrs_05_0901__li16453651121615"><strong id="sdrs_05_0901__b448864013166">server_groups</strong>: indicates a protection group.</li><li id="sdrs_05_0901__li13457951151618"><strong id="sdrs_05_0901__b6278123117182">protected_instances</strong>: indicates a protected instance.</li><li id="sdrs_05_0901__li3462135112161"><strong id="sdrs_05_0901__b1066174461817">replications</strong>: indicates a replication pair.</li><li id="sdrs_05_0901__li746545181613"><strong id="sdrs_05_0901__b9129114151919">disaster_recovery_drills</strong>: indicates a DR drill.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0901__row8647314102313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.1.2.1.5.1.1 "><p id="sdrs_05_0901__p26471814122310">limit</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.1.2.1.5.1.2 "><p id="sdrs_05_0901__p964761452315">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.1.2.1.5.1.3 "><p id="sdrs_05_0901__p1864761442310">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.1.2.1.5.1.4 "><p id="sdrs_05_0901__p171211213522">Specifies the maximum number of results returned each time.</p>
<p id="sdrs_05_0901__p168455995811">The value is a positive integer ranging from <strong id="sdrs_05_0901__b6013100620539">0</strong> to <strong id="sdrs_05_0901__b25293232205313">1000</strong>, and is <strong id="sdrs_05_0901__b6520879205318">1000</strong> by default.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row564818148231"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.1.2.1.5.1.1 "><p id="sdrs_05_0901__p36471414122314">offset</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.1.2.1.5.1.2 "><p id="sdrs_05_0901__p1664771482310">No</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.1.2.1.5.1.3 "><p id="sdrs_05_0901__p1648171472319">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.1.2.1.5.1.4 "><p id="sdrs_05_0901__p412313111528">Specifies the offset of each request. The default value is <strong id="sdrs_05_0901__b74201644142916">0</strong>.</p>
<p id="sdrs_05_0901__p2648201462319">The value must be a number and cannot be negative.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="section" id="sdrs_05_0901__section3134948112412"><h4 class="sectiontitle">Request</h4><ul id="sdrs_05_0901__ul13382194517387"><li id="sdrs_05_0901__li16666174651118">Request parameters<p id="sdrs_05_0901__p29420522113"><a name="sdrs_05_0901__li16666174651118"></a><a name="li16666174651118"></a>None</p>
</li><li id="sdrs_05_0901__li438213451383">Example request<p id="sdrs_05_0901__p3745925399"><a name="sdrs_05_0901__li438213451383"></a><a name="li438213451383"></a>GET https://{Endpoint}/v1/{project_id}/task-center/failure-jobs</p>
<p id="sdrs_05_0901__p276616221121">GET https://{Endpoint}/v1/{project_id}/task-center/failure-jobs?server_group_id=XXXXX</p>
<div class="note" id="sdrs_05_0901__note15817152815508"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="sdrs_05_0901__ul18656141015514"><li id="sdrs_05_0901__li1865621005116">If you do not specify <strong id="sdrs_05_0901__b626159113420">filter</strong> in the request, the system displays failed tasks of the protection group level, such as failed protection group creation or deletion tasks.</li><li id="sdrs_05_0901__li66564103519">To query failed tasks in a protection group, specify <strong id="sdrs_05_0901__b7660620133618">server_group_id</strong> in <strong id="sdrs_05_0901__b202213298365">filter</strong>.</li></ul>
</div></div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0901__section11837142115358"><h4 class="sectiontitle">Response</h4><ul id="sdrs_05_0901__ul9215202510539"><li id="sdrs_05_0901__li152151125115312">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0901__table12856421203510" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0901__row3815172218357"><th align="left" class="cellrowborder" valign="top" width="29.07%" id="mcps1.3.6.2.1.1.1.4.1.1"><p id="sdrs_05_0901__p1381517225355"><strong id="sdrs_05_0901__b18830155822219">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.6.2.1.1.1.4.1.2"><p id="sdrs_05_0901__p8815132253512"><strong id="sdrs_05_0901__b1810010876">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.49%" id="mcps1.3.6.2.1.1.1.4.1.3"><p id="sdrs_05_0901__p781532243513"><strong id="sdrs_05_0901__b181761827231">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0901__row18815322123513"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.1.1.4.1.1 "><p id="sdrs_05_0901__p85771357151815">failure_jobs</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.1.1.4.1.2 "><p id="sdrs_05_0901__p10815132233511">list</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.1.1.4.1.3 "><p id="sdrs_05_0901__p881562243512">Specifies the list of the failed tasks.</p>
<p id="sdrs_05_0901__p52914521264">For details, see <a href="#sdrs_05_0901__table687013217358">Table 1</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row08151122193517"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.1.1.4.1.1 "><p id="sdrs_05_0901__p17577105711818">count</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.1.1.4.1.2 "><p id="sdrs_05_0901__p18815322113517">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.1.1.4.1.3 "><p id="sdrs_05_0901__p18815142219355">Specifies the number of failed tasks in the list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sdrs_05_0901__table687013217358"></a><a name="table687013217358"></a><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0901__table687013217358" frame="border" border="1" rules="all"><caption><b>Table 1 </b><strong id="sdrs_05_0901__b03838278237">failure_jobs</strong> field description</caption><thead align="left"><tr id="sdrs_05_0901__row58152224359"><th align="left" class="cellrowborder" valign="top" width="29.07%" id="mcps1.3.6.2.1.2.2.4.1.1"><p id="sdrs_05_0901__p381542263514"><strong id="sdrs_05_0901__b2034817382255">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.6.2.1.2.2.4.1.2"><p id="sdrs_05_0901__p781519229359"><strong id="sdrs_05_0901__b95021340162511">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.49%" id="mcps1.3.6.2.1.2.2.4.1.3"><p id="sdrs_05_0901__p881532219350"><strong id="sdrs_05_0901__b160654116258">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0901__row1281692214358"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p47451737102718">job_status</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p081622212355">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p1118515312812">Specifies the task status.</p>
<p id="sdrs_05_0901__p178168220357">The value can be <strong id="sdrs_05_0901__b839715422511">FAIL</strong> only in current version.</p>
<ul id="sdrs_05_0901__ul85837493015"><li id="sdrs_05_0901__li558311417309"><strong id="sdrs_05_0901__b16764963262">FAIL</strong>: The task failed. </li></ul>
</td>
</tr>
<tr id="sdrs_05_0901__row538933343717"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p1474519372278">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p12475516274">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p178160225352">Specifies the resource ID.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row12173164763716"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p474543732713">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p202502552710">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p28164224351">Specifies the resource name.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row9691159384"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p1774503716276">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p3531046102712">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p16211535172710">Specifies the resource type.</p>
<ul id="sdrs_05_0901__ul4327624142514"><li id="sdrs_05_0901__li103271124192517"><strong id="sdrs_05_0901__b900814287">server_groups</strong>: indicates a protection group.</li><li id="sdrs_05_0901__li23274241258"><strong id="sdrs_05_0901__b1932506560">protected_instances</strong>: indicates a protected instance.</li><li id="sdrs_05_0901__li133276243254"><strong id="sdrs_05_0901__b666990728">replications</strong>: indicates a replication pair.</li><li id="sdrs_05_0901__li143271624112514"><strong id="sdrs_05_0901__b359380233">disaster_recovery_drills</strong>: indicates a DR drill.</li></ul>
</td>
</tr>
<tr id="sdrs_05_0901__row51683226381"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p1274533772719">failure_status</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p4541123182720">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p981662283512">Specifies the failed task status.</p>
<ul id="sdrs_05_0901__ul11996531259"><li id="sdrs_05_0901__li10992538256"><strong id="sdrs_05_0901__b803689506">createFail</strong>: indicates a creation failure.</li><li id="sdrs_05_0901__li14992533253"><strong id="sdrs_05_0901__b128634511">deleteFail</strong>: indicates a deletion failure.</li><li id="sdrs_05_0901__li18991053182518"><strong id="sdrs_05_0901__b187447760">attachFail</strong>: indicates an attachment failure.</li><li id="sdrs_05_0901__li899165342517"><strong id="sdrs_05_0901__b406603497">detachFail</strong>: indicates a detachment failure.</li><li id="sdrs_05_0901__li169911533250"><strong id="sdrs_05_0901__b1173770052">expandFail</strong>: indicates an expansion failure.</li><li id="sdrs_05_0901__li129965318257"><strong id="sdrs_05_0901__b1196334401">resizeFail</strong>: indicates a specification change failure.</li><li id="sdrs_05_0901__li999195311256"><strong id="sdrs_05_0901__b1494533239">startFail</strong>: indicates a protection enabling failure. </li><li id="sdrs_05_0901__li13100153202517"><strong id="sdrs_05_0901__b763440353">stopFail</strong>: indicates a protection disabling failure. </li><li id="sdrs_05_0901__li2100205392513"><strong id="sdrs_05_0901__b1184837308">reverseFail</strong>: indicates a planned failover failure.</li><li id="sdrs_05_0901__li81001531251"><strong id="sdrs_05_0901__b204838178">failoverFail</strong>: indicates a failover failure.</li><li id="sdrs_05_0901__li1410065314256"><strong id="sdrs_05_0901__b10447722181520">reprotectFail</strong>: indicates a re-protection enabling failure. </li></ul>
</td>
</tr>
<tr id="sdrs_05_0901__row281617220355"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p374510376273">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p68166224355">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p881620224359">Specifies the task ID.</p>
<p id="sdrs_05_0901__p3716113214520">This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in <a href="sdrs_05_0101.html">Querying the Job Status</a>.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row662314915372"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p16745153720274">job_type</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p17816172218355">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p381611221355">Specifies the task name.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row1081622283516"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p1374553722718">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p1281652283516">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p9816182233510">Specifies the task operation time.</p>
<p id="sdrs_05_0901__p64991126142213">The default format is as follows: "yyyy-MM-ddTHH:mm:ss.SSSZ", for example, <strong id="sdrs_05_0901__b16889113243016">2019-04-01T12:00:00.000Z</strong>.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row381617220359"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p57456374277">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p12597515277">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p19816172220358">Specifies the error code for a failed task.</p>
</td>
</tr>
<tr id="sdrs_05_0901__row1740150132615"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.6.2.1.2.2.4.1.1 "><p id="sdrs_05_0901__p3745537172714">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.6.2.1.2.2.4.1.2 "><p id="sdrs_05_0901__p626318552714">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.6.2.1.2.2.4.1.3 "><p id="sdrs_05_0901__p1542850192612">Specifies the task failure cause.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="sdrs_05_0901__ul84451664531"><li id="sdrs_05_0901__li204454616538">Example response<pre class="screen" id="sdrs_05_0901__screen12147103414495">{
"count": 2,
"failure_jobs": [
{
"job_status": "FAIL",
"resource_id": "17984002-ad8a-438b-8ba6-b850224634c5",
"resource_name": "Protected-Instance-ab14",
"resource_type": "protectedInstance",
"failure_status": "createFail",
"job_id": "ff808082686f229a0168707beaab014e",
"job_type": "createProtectedInstance",
"begin_time": "2019-01-21T12:56:35.754Z",
"error_code": "EVS.2024",
"fail_reason": "SdrsGenerateNativeServerParamsTask-fail:volume is error!"
},
{
"job_status": "FAIL",
"resource_id": "897f57b2-6e94-4179-b414-9532726c59f2",
"resource_name": "Protected-Instance-5e2e",
"resource_type": "protectedInstance",
"failure_status": "createFail",
"job_id": "ff808082686f229a0168707b9be9013e",
"job_type": "createProtectedInstance",
"begin_time": "2019-01-21T12:56:15.591Z",
"error_code": "EVS.2024",
"fail_reason": "SdrsGenerateNativeServerParamsTask-fail:volume is error!"
}
]
}</pre>
<div class="p" id="sdrs_05_0901__p7817182210354">Or<pre class="screen" id="sdrs_05_0901__screen46901443134913">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</div>
<div class="p" id="sdrs_05_0901__p181862210356">In this example, <strong id="sdrs_05_0901__b13669152717289">error</strong> represents a general error, including <strong id="sdrs_05_0901__b19670192792812">badrequest</strong> (shown below) and <strong id="sdrs_05_0901__b10671927142814">itemNotFound</strong>.<pre class="screen" id="sdrs_05_0901__screen19141249134913">{
"badrequest": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0901__section897722112352"><h4 class="sectiontitle"><strong id="sdrs_05_0901__b842352706175024">Returned Value</strong></h4><ul id="sdrs_05_0901__ul89411830115414"><li id="sdrs_05_0901__li13941630135410">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0901__table398016219357" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0901__row1481842213516"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.7.2.1.1.1.3.1.1"><p id="sdrs_05_0901__p2081822243510"><strong id="sdrs_05_0901__b9310104915293">Returned Value</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.7.2.1.1.1.3.1.2"><p id="sdrs_05_0901__p118187225354"><strong id="sdrs_05_0901__b1211785016294">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0901__row6818112243517"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.7.2.1.1.1.3.1.1 "><p id="sdrs_05_0901__p12824172203511">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.7.2.1.1.1.3.1.2 "><p id="sdrs_05_0901__p1782472243510">The server has accepted the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sdrs_05_0901__li131308335548">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0901__sdrs_05_0101_table22458872203835" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0901__sdrs_05_0101_row35704554203835"><th align="left" class="cellrowborder" valign="top" width="43.419999999999995%" id="mcps1.3.7.2.2.1.1.3.1.1"><p id="sdrs_05_0901__sdrs_05_0101_p6387753203835">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.58%" id="mcps1.3.7.2.2.1.1.3.1.2"><p id="sdrs_05_0901__sdrs_05_0101_p47646009203835">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0901__sdrs_05_0101_row34121538203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p12381163203835">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p63350108203835">The server failed to process the request.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row33280063203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p11330608203835">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p45364094203835">You must enter a username and the password to access the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row5623667203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p52863895203835">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p54117066203835">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row17291554203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p58438642203835">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p35909542203835">The server could not find the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row54750425203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p5599455203835">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p50902717203835">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row55471277203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p63988484203835">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p15684678203835">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row6944380203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p25623884203835">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p62268733203835">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row23547689203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p28314670203835">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p11786919203835">The request timed out.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row38973411203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p2729702203835">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p19779281203835">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row43795805203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p57799353203835">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p51235984203835">Failed to complete the request because of a service error.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row58470678203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p38504500203835">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p31856770203835">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row18275474203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p3918444203835">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p48958538203835">Failed to complete the request because the server receives an invalid response from an upstream server.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row37973662203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p55967806203835">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p37098455203835">Failed to complete the request because the system is unavailable.</p>
</td>
</tr>
<tr id="sdrs_05_0901__sdrs_05_0101_row65450640203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="sdrs_05_0901__sdrs_05_0101_p67010448203835">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="sdrs_05_0901__sdrs_05_0101_p59137180203835">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sdrs_05_0900.html">Task Center</a></div>
</div>
</div>
View Git Blame Copy Permalink