vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_10_0100.html
Ru, Li Yi 37b97ffc06 geminidb_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-07-04 11:26:33 +00:00

295 lines
25 KiB
HTML
Raw Blame History

<a name="nosql_10_0100"></a><a name="nosql_10_0100"></a>
<h1 class="topictitle1">Querying Tasks and Details</h1>
<div id="body0000001803995037"><div class="section" id="nosql_10_0100__section540014141047"><h4 class="sectiontitle">Function</h4><p id="nosql_10_0100__p2575142172015">This API is used to query tasks (by default) and details.</p>
</div>
<div class="section" id="nosql_10_0100__section14167141741"><h4 class="sectiontitle">URI</h4><p id="nosql_10_0100__p941711149420">GET https://{Endpoint}/v3/{project_id}/jobs</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0100__table16421514342" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_10_0100__row54191714449"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="nosql_10_0100__p19423714946">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="nosql_10_0100__p1424141417416">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="nosql_10_0100__p134261714545">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="nosql_10_0100__p44280148412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_10_0100__row14419214947"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="nosql_10_0100__p442941410418">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="nosql_10_0100__p18431141414410">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="nosql_10_0100__p194333145414">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="nosql_10_0100__p11434111413420">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0100__table1444631416415" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="nosql_10_0100__row14439144419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="nosql_10_0100__p14464141047">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="nosql_10_0100__p1144812146415">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="nosql_10_0100__p2045011144413">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="nosql_10_0100__p845119149414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_10_0100__row7443201415412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nosql_10_0100__p457013425236">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nosql_10_0100__p1757094216234">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nosql_10_0100__p14570942192313">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nosql_10_0100__p15701342152313">Task ID.</p>
</td>
</tr>
<tr id="nosql_10_0100__row144431914245"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nosql_10_0100__p15701742152316">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nosql_10_0100__p125701442132314">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nosql_10_0100__p1057144222316">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nosql_10_0100__p1977445620355">Query start time in the "yyyy-mm-ddThh:mm:ssZ" format. The default value is 30 days before the current date.</p>
<p id="nosql_10_0100__p1357104214231"><strong id="nosql_10_0100__b5126174015317">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_10_0100__b111262401733">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="nosql_10_0100__row0444171418417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nosql_10_0100__p1157113429234">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nosql_10_0100__p2571144212230">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nosql_10_0100__p2057174215233">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nosql_10_0100__p65151163619">End time (the current time by default) in the "yyyy-mm-ddThh:mm:ssZ" format. It must be later than the start time and the time span cannot exceed 30 days.</p>
<p id="nosql_10_0100__p457117429232"><strong id="nosql_10_0100__b94542168695746">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_10_0100__b127321399895746">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="nosql_10_0100__row34440145417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nosql_10_0100__p1557116424233">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nosql_10_0100__p1857194214231">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nosql_10_0100__p185715422237">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nosql_10_0100__p1557194214236">Task status. The value can be: <strong id="nosql_10_0100__b1869394611100">Running</strong>, indicating that the task is being executed. <strong id="nosql_10_0100__b1596117191112">Completed</strong>, indicating that the task is completed. <strong id="nosql_10_0100__b42511244119">Failed</strong>, indicating that the task fails.</p>
</td>
</tr>
<tr id="nosql_10_0100__row194441814849"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nosql_10_0100__p3571042182311">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nosql_10_0100__p12571124220232">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nosql_10_0100__p55718424239">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nosql_10_0100__p85711042112320">Task name.</p>
<ul id="nosql_10_0100__ul12571164218237"><li id="nosql_10_0100__li25711142122311"><strong id="nosql_10_0100__b1255242013197">CreateInstance</strong>: Create an instance.</li><li id="nosql_10_0100__li11572842122312"><strong id="nosql_10_0100__b10333851111918">RestoreNewInstance</strong>: Restore data to a new instance.</li><li id="nosql_10_0100__li11572184218230"><strong id="nosql_10_0100__b1516761092111">EnlargeInstance</strong>: Add nodes.</li><li id="nosql_10_0100__li7572942132313"><strong id="nosql_10_0100__b114048273232">ReduceInstance</strong>: Delete nodes.</li><li id="nosql_10_0100__li95721042132315"><strong id="nosql_10_0100__b1099944911230">RestartInstance</strong>: Restart an instance.</li><li id="nosql_10_0100__li135726422232"><strong id="nosql_10_0100__b155918329247">RestartNode</strong>: Restart a node.</li><li id="nosql_10_0100__li757215425230"><strong id="nosql_10_0100__b1759465692411">EnlargeInstanceVolume</strong>: Scale up storage space of an instance.</li><li id="nosql_10_0100__li19572144222318"><strong id="nosql_10_0100__b7218752132520">ReduceInstanceVolume</strong>: Scale in storage space of an instance.</li><li id="nosql_10_0100__li105721142142310"><strong id="nosql_10_0100__b7791135672618">ResizeInstance</strong>: Change the specifications of an instance.</li><li id="nosql_10_0100__li145721242182315"><strong id="nosql_10_0100__b151971818122820">UpgradeDbVersion</strong>: Upgrade the engine version.</li><li id="nosql_10_0100__li11572184214236"><strong id="nosql_10_0100__b23411315297">BindPublicIP</strong>: Bind an EIP to an instance.</li><li id="nosql_10_0100__li2057274217237"><strong id="nosql_10_0100__b662020592294">UnbindPublicIP</strong>: Unbind an EIP from an instance.</li><li id="nosql_10_0100__li13572174216239"><strong id="nosql_10_0100__b13985151263120">DeleteInstance</strong>: Delete an instance.</li><li id="nosql_10_0100__li8572842142319"><strong id="nosql_10_0100__b7717221183110">EnlargeInstanceColdVolume</strong>: Scale up cold storage of an instance.</li><li id="nosql_10_0100__li185722429239"><strong id="nosql_10_0100__b10960932205910">AddInstanceColdVolume</strong>: Enable cold storage for an instance.</li><li id="nosql_10_0100__li195721642192317"><strong id="nosql_10_0100__b101462279895746">ModifySecurityGroup</strong>: Modify a security group.</li><li id="nosql_10_0100__li185727421238"><strong id="nosql_10_0100__b13025443515">ModifyCcmCert</strong>: Modify a CCM certificate.</li><li id="nosql_10_0100__li95722426232"><strong id="nosql_10_0100__b16171469363">ModifyPort</strong>: Change a port.</li><li id="nosql_10_0100__li9572642192315"><strong id="nosql_10_0100__b117731750133719">ConstructDisasterRecovery</strong>: Establish a DR relationship.</li><li id="nosql_10_0100__li165728424239"><strong id="nosql_10_0100__b165468115383">DeConstructDisasterRecovery</strong>: Remove a DR relationship.</li><li id="nosql_10_0100__li17572174212318"><strong id="nosql_10_0100__b465444719386">SwitchOverDisasterRecovery</strong>: Switch a DR relationship.</li><li id="nosql_10_0100__li14572642202310"><strong id="nosql_10_0100__b18506235113915">BuildBiActiveInstance</strong>: Create an instance with a dual-active DR relationship.</li><li id="nosql_10_0100__li45726426237"><strong id="nosql_10_0100__b1208111474912">ReleaseBiActiveInstance</strong>: Remove a dual-active relationship from an instance.</li><li id="nosql_10_0100__li1857374213233"><strong id="nosql_10_0100__b1297928175010">BackupInstance</strong>: Back up an instance.</li></ul>
</td>
</tr>
<tr id="nosql_10_0100__row134441144417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nosql_10_0100__p357304222312">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nosql_10_0100__p45731542112314">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nosql_10_0100__p18573144211232">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nosql_10_0100__p1884411107360">Index offset.</p>
<p id="nosql_10_0100__p16573642192311">If <strong id="nosql_10_0100__b197051476519">offset</strong> is set to <em id="nosql_10_0100__i87050479517">N</em>, the resource query starts from the <em id="nosql_10_0100__i1670674712517">N</em>+1 piece of data. The value is <strong id="nosql_10_0100__b5706747155110">0</strong> by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.</p>
</td>
</tr>
<tr id="nosql_10_0100__row1156155711231"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="nosql_10_0100__p3561115732313">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="nosql_10_0100__p9561125752311">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="nosql_10_0100__p756175719233">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="nosql_10_0100__p5561257182314">Number of records to be queried. The value can be <strong id="nosql_10_0100__b61627154522">10</strong>, <strong id="nosql_10_0100__b693171795216">20</strong>, or <strong id="nosql_10_0100__b77352065211">50</strong>. The default value is <strong id="nosql_10_0100__b1822612213528">50</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_10_0100__section7509101414414"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0100__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="nosql_10_0100__row551114141446"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="nosql_10_0100__p651418147413">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="nosql_10_0100__p751719141646">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="nosql_10_0100__p9520314848">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="nosql_10_0100__p752241412410">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_10_0100__row1651120141642"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="nosql_10_0100__p12524114448">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="nosql_10_0100__p1852571412411">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="nosql_10_0100__p1252719141642">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="nosql_10_0100__p1528814542">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_10_0100__section1053116144413"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_10_0100__p1053311416418"><strong id="nosql_10_0100__b17534814142">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0100__response_ListSlowlogsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_10_0100__row105345148412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="nosql_10_0100__p95372014549">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.3.2.4.1.2"><p id="nosql_10_0100__p155413141142">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="nosql_10_0100__p6543101415415">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_10_0100__row19535171415411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="nosql_10_0100__p17927133962513">jobs</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.3.2.4.1.2 "><p id="nosql_10_0100__p29271396253">Array of objects (<a href="#nosql_10_0100__response_SlowlogResult">Table 5</a>)</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="nosql_10_0100__p199272039192515">Task list.</p>
</td>
</tr>
<tr id="nosql_10_0100__row1953515141843"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="nosql_10_0100__p14927143992517">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.3.2.4.1.2 "><p id="nosql_10_0100__p692720395254">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="nosql_10_0100__p119271639172520">Total number of tasks in the task list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_10_0100__response_SlowlogResult"></a><a name="response_SlowlogResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0100__response_SlowlogResult" frame="border" border="1" rules="all"><caption><b>Table 5 </b>JobDetail</caption><thead align="left"><tr id="nosql_10_0100__row555561412420"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="nosql_10_0100__p1755820142411">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.4.2.4.1.2"><p id="nosql_10_0100__p1456011141742">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="nosql_10_0100__p45616148418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_10_0100__row755581411410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p5684171510279">id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p668416150272">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p86841915142715">Task ID.</p>
</td>
</tr>
<tr id="nosql_10_0100__row655516141643"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p18684161592715">name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p1168471511277">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p0684191515276">Task name.</p>
</td>
</tr>
<tr id="nosql_10_0100__row1555515149414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p968418153271">status</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p12684191522712">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p19684815122717">Task execution status. The value can be: <strong id="nosql_10_0100__b1723317378538">Running</strong>, indicating that the task is being executed. <strong id="nosql_10_0100__b159957319372">Completed</strong> indicating that the task has been successfully executed. <strong id="nosql_10_0100__b143118474549">Failed</strong> indicating that the task fails to be executed.</p>
</td>
</tr>
<tr id="nosql_10_0100__row555511414412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p14684191519276">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p17684181512713">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p868417156271">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="nosql_10_0100__p14684131512716"><strong id="nosql_10_0100__b34500619895746">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_10_0100__b188302476295746">Z</strong> indicates the time zone offset. For example, in the Beijing time zone, the offset is <strong id="nosql_10_0100__b69732997395746">+0800</strong>.</p>
</td>
</tr>
<tr id="nosql_10_0100__row65558141443"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p18685141519277">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p1685315172713">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p2685131522716">End time in the yyyy-mm-ddThh:mm:ssZ format.</p>
<p id="nosql_10_0100__p186853156279"><strong id="nosql_10_0100__b114983881495746">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_10_0100__b181477973595746">Z</strong> indicates the time zone offset. For example, in the Beijing time zone, the offset is <strong id="nosql_10_0100__b72672384795746">+0800</strong>.</p>
</td>
</tr>
<tr id="nosql_10_0100__row12753631275"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p166851615112718">progress</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p96850154272">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p1568511154273">Task execution progress.</p>
<div class="note" id="nosql_10_0100__note4631121572717"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="nosql_10_0100__p146851415102718">The execution progress (such as <strong id="nosql_10_0100__b11489545175520">"60%"</strong>, indicating the task execution progress is 60%) is displayed only when the task is being executed. Otherwise, <strong id="nosql_10_0100__b64908451551">""</strong> is returned.</p>
</div></div>
</td>
</tr>
<tr id="nosql_10_0100__row109895718272"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p176851715132710">instance</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p8685215102712">Objects in <a href="#nosql_10_0100__table762814573276">Table 6</a></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p176851152272">Details of the instance associated with the task.</p>
</td>
</tr>
<tr id="nosql_10_0100__row393711115275"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="nosql_10_0100__p6685615152713">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.2 "><p id="nosql_10_0100__p1168510155277">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="nosql_10_0100__p468531516272">Task failure information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_10_0100__table762814573276"></a><a name="table762814573276"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_10_0100__table762814573276" frame="border" border="1" rules="all"><caption><b>Table 6 </b>JobInstanceInfo</caption><thead align="left"><tr id="nosql_10_0100__row17628115732716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="nosql_10_0100__p15629115716273">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.5.2.4.1.2"><p id="nosql_10_0100__p962965732718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="nosql_10_0100__p16291457162719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_10_0100__row1962985742715"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="nosql_10_0100__p171173237283">id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.5.2.4.1.2 "><p id="nosql_10_0100__p12117122342811">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="nosql_10_0100__p121174234283">Instance ID.</p>
</td>
</tr>
<tr id="nosql_10_0100__row3629135714276"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="nosql_10_0100__p1911722311282">name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.5.2.4.1.2 "><p id="nosql_10_0100__p171171923152815">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="nosql_10_0100__p011716236285">Instance name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_10_0100__section145912149420"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_10_0100__ul859414140419"><li id="nosql_10_0100__li1594214243">URI example<pre class="screen" id="nosql_10_0100__screen1459816144416">GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/jobs?id=89a0cde6-9c46-4b89-a92c-573e1083ff23</pre>
</li></ul>
</div>
<div class="section" id="nosql_10_0100__section156341714946"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_10_0100__p18635181412416"><strong id="nosql_10_0100__b1263611414412">Status code: 200</strong></p>
<p id="nosql_10_0100__p96371714343">Success</p>
<pre class="screen" id="nosql_10_0100__screen186401714643">{
"total_count" : 1,
"jobs" : [ {
"id" : "6f85e061-04dd-42e7-86d6-d3b1e40aac2e",
"name" : "CreateCassandra",
"status" : "Running",
"start_time" : "2023-09-12T06:44:01+0000",
"end_time" : "2023-09-12T06:44:03+0000",
"progress" : "14%",
"instance" : {
"id" : "27a045b6bf9e46f691f81366d398cb04in06",
"name" : "nosql-12f5"
},
"fail_reason" : ""
} ]
}</pre>
</div>
<div class="section" id="nosql_10_0100__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_10_0100__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_10_0100__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_10_0100__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000016.html">Task Management</a></div>
</div>
</div>
View Git Blame Copy Permalink