vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/opengauss/api-ref/opengauss_newapi_0072.html
Ru, Li Yi d97aea4dd2 opengauss_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-09-06 09:04:21 +00:00

277 lines
28 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001947569857"></a><a name="EN-US_TOPIC_0000001947569857"></a>
<h1 class="topictitle1">Querying Tasks</h1>
<div id="body0000001416005188"><div class="section" id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_section150205102514"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001947569857__p143898536615">This API is used to query the tasks in the task center. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000001947569857__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001947569857__en-us_topic_0136489341_section1461493103419"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000001947569857__p8750124845211">The tasks of the last month can be queried at most.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_section106755832618"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_ul1487413230526"><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_li14874623115217">URI format<p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p9874142312522"><a name="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_li14874623115217"></a><a name="en-us_topic_0151958051_li14874623115217"></a>GET https://{<em id="EN-US_TOPIC_0000001947569857__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{project_id}/tasks</p>
</li><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_li4411135064210">Example<ul id="EN-US_TOPIC_0000001947569857__ul1370710642015"><li id="EN-US_TOPIC_0000001947569857__li3707362209">Querying running tasks<p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p1454414211213"><a name="EN-US_TOPIC_0000001947569857__li3707362209"></a><a name="li3707362209"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Running&amp;name=Create<span id="EN-US_TOPIC_0000001947569857__text1829517074">GaussDB</span>V5Instance&amp;offset=1&amp;limit=10</p>
</li><li id="EN-US_TOPIC_0000001947569857__li106756419222">Querying completed tasks<p id="EN-US_TOPIC_0000001947569857__p17747134672312"><a name="EN-US_TOPIC_0000001947569857__li106756419222"></a><a name="li106756419222"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Completed&amp;name=Create<span id="EN-US_TOPIC_0000001947569857__text16747546142315">GaussDB</span>V5Instance&amp;offset=1&amp;limit=10</p>
</li><li id="EN-US_TOPIC_0000001947569857__li1955321011239">Querying failed tasks<p id="EN-US_TOPIC_0000001947569857__p1551411192520"><a name="EN-US_TOPIC_0000001947569857__li1955321011239"></a><a name="li1955321011239"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0611f1bd8b00d5d32f17c017f15b599f/tasks?status=Failed&amp;name=Create<span id="EN-US_TOPIC_0000001947569857__text1751451192513">GaussDB</span>V5Instance&amp;offset=1&amp;limit=10</p>
</li></ul>
</li><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_li187472315526">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_table1576811235520" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_row18751223155212"><th align="left" class="cellrowborder" valign="top" width="21.89%" id="mcps1.3.3.2.3.1.2.5.1.1"><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p187572313527">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.16%" id="mcps1.3.3.2.3.1.2.5.1.2"><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p10875132325219">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="7.5200000000000005%" id="mcps1.3.3.2.3.1.2.5.1.3"><p id="EN-US_TOPIC_0000001947569857__p09261119171512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.43%" id="mcps1.3.3.2.3.1.2.5.1.4"><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p12875122313523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_row178751238528"><td class="cellrowborder" valign="top" width="21.89%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p128751523105218">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.16%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p108751223195218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569857__p119276192157">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p887592312524">Project ID of a tenant in a region.</p>
<p id="EN-US_TOPIC_0000001947569857__p8544202712219">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_row387582335220"><td class="cellrowborder" valign="top" width="21.89%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569857__p167981822171214">status</p>
</td>
<td class="cellrowborder" valign="top" width="20.16%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p15875723185214">No</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569857__p13927319191515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569857__p193061318171419">Task status. Value:</p>
<ul id="EN-US_TOPIC_0000001947569857__ul1138602451410"><li id="EN-US_TOPIC_0000001947569857__li1838622414144"><strong id="EN-US_TOPIC_0000001947569857__b94435755843729">Running</strong></li><li id="EN-US_TOPIC_0000001947569857__li1138619244143"><strong id="EN-US_TOPIC_0000001947569857__b4533124653318">Completed</strong></li><li id="EN-US_TOPIC_0000001947569857__li16861428131413"><strong id="EN-US_TOPIC_0000001947569857__b20536111583417">Failed</strong></li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row1394733683217"><td class="cellrowborder" valign="top" width="21.89%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569857__p1969117289121">name</p>
</td>
<td class="cellrowborder" valign="top" width="20.16%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569857__p1894893633212">No</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569857__p189277199159">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569857__p1585173731417">Task name.</p>
<ul id="EN-US_TOPIC_0000001947569857__ul116415437141"><li id="EN-US_TOPIC_0000001947569857__li13641943131418"><strong id="EN-US_TOPIC_0000001947569857__b14665676419">CreateGaussDBV5Instance</strong>: Creating a DB instance</li><li id="EN-US_TOPIC_0000001947569857__li19641543151412"><strong id="EN-US_TOPIC_0000001947569857__b8641174381411">BackupSnapshotGaussDBV5InInstance</strong>: Creating a manual backup</li><li id="EN-US_TOPIC_0000001947569857__li1641114318146"><strong id="EN-US_TOPIC_0000001947569857__b6641184341413">CloneGaussDBV5NewInstance</strong>: Restoring data to a new DB instance</li><li id="EN-US_TOPIC_0000001947569857__li13641144361416"><strong id="EN-US_TOPIC_0000001947569857__b152666177352">RestoreGaussDBV5InInstance</strong>: Restoring data to the original DB instance</li><li id="EN-US_TOPIC_0000001947569857__li943711381717"><strong id="EN-US_TOPIC_0000001947569857__b8368112164118">RestoreGaussDBV5InInstanceToExistedInst</strong>: Restoring data to an existing DB instance</li><li id="EN-US_TOPIC_0000001947569857__li1564294321418"><strong id="EN-US_TOPIC_0000001947569857__b5632216134119">DeleteGaussDBV5Instance</strong>: Deleting a DB instance</li><li id="EN-US_TOPIC_0000001947569857__li116421434147"><strong id="EN-US_TOPIC_0000001947569857__b1687161864117">EnlargeGaussDBV5Volume</strong>: Scaling up storage</li><li id="EN-US_TOPIC_0000001947569857__li116423431148"><strong id="EN-US_TOPIC_0000001947569857__b95712212416">ResizeGaussDBV5Flavor</strong>: Changing specifications</li><li id="EN-US_TOPIC_0000001947569857__li166424434148"><strong id="EN-US_TOPIC_0000001947569857__b0642114331419">GaussDBV5ExpandClusterCN</strong>: Adding coordinator nodes</li><li id="EN-US_TOPIC_0000001947569857__li2097011477146"><strong id="EN-US_TOPIC_0000001947569857__b186421843111412">GaussDBV5ExpandClusterDN</strong>: Adding shards</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row86083791214"><td class="cellrowborder" valign="top" width="21.89%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569857__p16013715121">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20.16%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569857__p32960390151">No</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569857__p16927419191510">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569857__p26013377127">Start time. The value is a UNIX timestamp, in milliseconds. The time zone is UTC.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row910614403125"><td class="cellrowborder" valign="top" width="21.89%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569857__p1106164051213">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20.16%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569857__p11375407157">No</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569857__p19927819101515">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569857__p5106124014124">End time. The value is a UNIX timestamp, in milliseconds. The time zone is UTC.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row958724310128"><td class="cellrowborder" valign="top" width="21.89%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569857__p258711432128">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20.16%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569857__p1853211409157">No</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569857__p19927219121512">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569857__p1587124331214">Index offset. If <strong id="EN-US_TOPIC_0000001947569857__b768639938102233">offset</strong> is set to <em id="EN-US_TOPIC_0000001947569857__i844474641102233">N</em>, the resource query starts from the N+1 piece of data. The default value is <strong id="EN-US_TOPIC_0000001947569857__b1707387278102233">0</strong>, indicating that the query starts from the first piece of data. The value cannot be a negative number.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row6674161710133"><td class="cellrowborder" valign="top" width="21.89%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569857__p767471791313">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20.16%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569857__p11245114161519">No</p>
</td>
<td class="cellrowborder" valign="top" width="7.5200000000000005%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569857__p2927619101519">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50.43%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569857__p9674161741318">Number of records to be queried. The default value is <strong id="EN-US_TOPIC_0000001947569857__b1279716292310">100</strong>. The value cannot be a negative number. The minimum value is <strong id="EN-US_TOPIC_0000001947569857__b0798162943117">1</strong> and the maximum value is <strong id="EN-US_TOPIC_0000001947569857__b879922915318">100</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_section1265133172714"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001947569857__p51911392813">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_section159912464345"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_ul28758235521"><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_li158771723155214">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_table137871523165214" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_row38777235523"><th align="left" class="cellrowborder" valign="top" width="33.68%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p128770232529">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.47%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p78771723175214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.85%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p78775237527">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_row6877523135212"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p662483310208">tasks</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0128427213_p1420620152206"></p>
<p id="EN-US_TOPIC_0000001947569857__en-us_topic_0128427213_p1161892377">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p1762102618211">Task list.</p>
<p id="EN-US_TOPIC_0000001947569857__p9710162362015">For details, see <a href="#EN-US_TOPIC_0000001947569857__table27316396223">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row1988225114318"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p127822406206">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p5307181912110">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p8537193117218">Number of tasks.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001947569857__table27316396223"></a><a name="table27316396223"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569857__table27316396223" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tasks field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569857__row10731123918224"><th align="left" class="cellrowborder" valign="top" width="33.68%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001947569857__p973112394222">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.47%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001947569857__p107313392229">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.85%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001947569857__p1273112391222">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001947569857__row173163915223"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p137311639122219">instance_info</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p4731103918222">Object</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p7223125915271">Information about the instance associated with the task.</p>
<p id="EN-US_TOPIC_0000001947569857__p4499719122112">For details, see <a href="#EN-US_TOPIC_0000001947569857__table1126382493011">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row18731133920223"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p137311391229">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p873117396225">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p3904565287">Task ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row17909124862315"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p1690984810230">name</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p6909184817234">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p190954832319">Task name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row02033525232"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p1120319522234">status</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p120318523234">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p72031952112316">Task status.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row1891205502315"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p1391855162310">process</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p15915553235">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p149114556236">Task progress, in percentage (%)</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row1135542918241"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p8355152918242">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p4355192972417">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p8355172919244">Failure cause.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row843010351245"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p138421531173417">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p12843131183410">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p1978183453618">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="EN-US_TOPIC_0000001947569857__p14978133414368"><strong id="EN-US_TOPIC_0000001947569857__b16494169144120">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="EN-US_TOPIC_0000001947569857__b1049410934119">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row0104933842"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p10762153513345">ended_at</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p576253510342">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p1521448103615">End time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="EN-US_TOPIC_0000001947569857__p65274810361"><strong id="EN-US_TOPIC_0000001947569857__b363532417416">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="EN-US_TOPIC_0000001947569857__b19635132404113">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001947569857__table1126382493011"></a><a name="table1126382493011"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569857__table1126382493011" frame="border" border="1" rules="all"><caption><b>Table 4 </b>instance_info field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569857__row12263224113014"><th align="left" class="cellrowborder" valign="top" width="33.68%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0000001947569857__p626318243305">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.47%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000001947569857__p122632024183011">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.85%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000001947569857__p926316247309">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001947569857__row1626322433010"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p1184775911302">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p18219827203112">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p4264224133018">DB instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row1126412417309"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p1913599103117">instance_name</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p19311183019311">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p128092406317">DB instance name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001947569857__row311731219313"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569857__p1811841213310">instance_status</p>
</td>
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569857__p1911841273118">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569857__p011811124313">Instance status.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_ul42421820113517"><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_li5242142010359">Example normal response<pre class="screen" id="EN-US_TOPIC_0000001947569857__screen980320193320">{
"tasks" : [ {
"instance_info" : {
"instance_id" : "ce2dce50f365430abe161bab79495a6ein14",
"instance_name" : "gauss-6568-zzh",
"instance_status" : "creating"
},
"job_id" : "03bc055a-135c-4245-8bd8-b0bc6d3350b3",
"name" : "CreateGaussDBV5Instance",
"status" : "Failed",
"process" : null,
"fail_reason" : "An exception occurs when the ECS processes services.",
"created_at": "2022-08-05T08:15:07+0800",
"ended_at": "2022-08-09T03:06:52+0800"
}, {
"instance_info" : {
"instance_id" : "20ba433bd7ee40da9cf35064f04f9e4cin14",
"instance_name" : "gauss-7875-lt-m",
"instance_status" : "deleted"
},
"job_id" : "2cc16e0b-75ab-4a28-9453-16517e990bba",
"name" : "DeleteGaussDBV5Instance",
"status" : "Completed",
"process" : null,
"fail_reason" : null,
"created_at": "2022-08-06T09:15:07+0800",
"ended_at": "2022-08-10T03:06:52+0800"
} ],
"total_count" : 2
}</pre>
</li><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_li4328453192">Abnormal response<p id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_p58771023185211"><a name="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_li4328453192"></a><a name="en-us_topic_0151958051_li4328453192"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
<div class="section" id="EN-US_TOPIC_0000001947569857__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001947569857__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001947569857__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001947569857__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
</li><li id="EN-US_TOPIC_0000001947569857__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001947569857__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001947569857__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001947569857__en-us_topic_0151958051_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001947569857__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_newapi_0034.html">Task Management</a></div>
</div>
</div>
View Git Blame Copy Permalink