forked from docs/doc-exports
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com> Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
316 lines
24 KiB
HTML
316 lines
24 KiB
HTML
<a name="ShowGaussMySqlJobInfo"></a><a name="ShowGaussMySqlJobInfo"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Information About a Task with a Specified ID</h1>
|
|
<div id="body0000001310979474"><div class="section" id="ShowGaussMySqlJobInfo__section6603527917262"><h4 class="sectiontitle">Function</h4><p id="ShowGaussMySqlJobInfo__p4725737717262">This API is used to obtain task information from the task center. Before calling this API:</p>
|
|
<ul id="ShowGaussMySqlJobInfo__ul924420236520"><li id="ShowGaussMySqlJobInfo__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="ShowGaussMySqlJobInfo__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="ShowGaussMySqlJobInfo__section1673735194018"><h4 class="sectiontitle">Constraints</h4><ul id="ShowGaussMySqlJobInfo__ul77343544018"><li id="ShowGaussMySqlJobInfo__li4741835184011">This API is used to query asynchronous tasks of the last one month in the task center.</li><li id="ShowGaussMySqlJobInfo__li18748356404">After a job is generated, it takes several seconds to query the job ID.</li></ul>
|
|
</div>
|
|
<div class="section" id="ShowGaussMySqlJobInfo__section17405171911145"><h4 class="sectiontitle">URI</h4><p id="ShowGaussMySqlJobInfo__p8405141915147">GET /v3/{project_id}/jobs?id={id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__table13406131913142" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row34054194144"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ShowGaussMySqlJobInfo__p1340614195144">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ShowGaussMySqlJobInfo__p5406191913140">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ShowGaussMySqlJobInfo__p10406319141414">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ShowGaussMySqlJobInfo__p3406819181414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowGaussMySqlJobInfo__row134051619151413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ShowGaussMySqlJobInfo__p1140618194145">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ShowGaussMySqlJobInfo__p10406101921414">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ShowGaussMySqlJobInfo__p1940621981410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ShowGaussMySqlJobInfo__p136741645101515">Project ID of a tenant in a region.</p>
|
|
<p id="ShowGaussMySqlJobInfo__p167424511515">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__table104079198140" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row6407191931412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ShowGaussMySqlJobInfo__p14407121917143">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ShowGaussMySqlJobInfo__p340714197149">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="ShowGaussMySqlJobInfo__p94072019171418">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="ShowGaussMySqlJobInfo__p18407319111417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowGaussMySqlJobInfo__row1540781931415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ShowGaussMySqlJobInfo__p340731914148">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ShowGaussMySqlJobInfo__p11408121911411">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ShowGaussMySqlJobInfo__p1408121991412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ShowGaussMySqlJobInfo__p1740891971412">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowGaussMySqlJobInfo__section3408319121414"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row16408419111419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="ShowGaussMySqlJobInfo__p1840851981412">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="ShowGaussMySqlJobInfo__p24094195146">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="ShowGaussMySqlJobInfo__p24091319101416">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="ShowGaussMySqlJobInfo__p54094196148">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowGaussMySqlJobInfo__row13408119111417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ShowGaussMySqlJobInfo__p8409201911142">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ShowGaussMySqlJobInfo__p940941961411">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ShowGaussMySqlJobInfo__p2409319171419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ShowGaussMySqlJobInfo__p1440914199145">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row1540801931418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="ShowGaussMySqlJobInfo__p1340991917147">X-Language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="ShowGaussMySqlJobInfo__p7409131961415">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="ShowGaussMySqlJobInfo__p44091919201418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="ShowGaussMySqlJobInfo__p3410719111412">Language.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowGaussMySqlJobInfo__section104102196141"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowGaussMySqlJobInfo__p10410141918146"><strong id="ShowGaussMySqlJobInfo__b18410151916146">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__response_GetJobInfoResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameter</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row6410121911414"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="ShowGaussMySqlJobInfo__p1341018193149">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="ShowGaussMySqlJobInfo__p124102019191418">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="ShowGaussMySqlJobInfo__p10410131941417">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowGaussMySqlJobInfo__row9410171918144"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p1341171951413">job</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p64111192144"><a href="#ShowGaussMySqlJobInfo__response_GetJobInfoDetail">GetJobInfoDetail</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p19411171919148">Task information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowGaussMySqlJobInfo__response_GetJobInfoDetail"></a><a name="response_GetJobInfoDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__response_GetJobInfoDetail" frame="border" border="1" rules="all"><caption><b>Table 5 </b>GetJobInfoDetail</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row11412111901419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="ShowGaussMySqlJobInfo__p541201931419">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.2"><p id="ShowGaussMySqlJobInfo__p141221913149">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.4.2.4.1.3"><p id="ShowGaussMySqlJobInfo__p841201913145">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowGaussMySqlJobInfo__row74121719161419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p541311912141">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p2413519101415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p104137195143">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row194121197140"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p18413151931417">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p18413619101417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p14413719191416">Task name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row3412181917143"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p6413111912145">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p74136194145">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p1841412196146">Task execution status.</p>
|
|
<p id="ShowGaussMySqlJobInfo__p1041411915147">Value:</p>
|
|
<ul id="ShowGaussMySqlJobInfo__ul44146197144"><li id="ShowGaussMySqlJobInfo__li11414191951419"><strong id="ShowGaussMySqlJobInfo__b1191598222104835">Running</strong>: The task is being executed.</li><li id="ShowGaussMySqlJobInfo__li3414181971412"><strong id="ShowGaussMySqlJobInfo__b1499406835104835">Completed</strong>: The task is successfully executed.</li><li id="ShowGaussMySqlJobInfo__li1341431916147"><strong id="ShowGaussMySqlJobInfo__b807728211104835">Failed</strong>: The task fails to be executed.</li></ul>
|
|
<p id="ShowGaussMySqlJobInfo__p741411197148">Valid value:</p>
|
|
<ul id="ShowGaussMySqlJobInfo__ul14143192149"><li id="ShowGaussMySqlJobInfo__li154148199145"><strong id="ShowGaussMySqlJobInfo__b6414141981419">Running</strong></li><li id="ShowGaussMySqlJobInfo__li18414619171410"><strong id="ShowGaussMySqlJobInfo__b141415196147">Completed</strong></li><li id="ShowGaussMySqlJobInfo__li12414131931416"><strong id="ShowGaussMySqlJobInfo__b174145193142">Failed</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row19412121941418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p13414171914149">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p1341512199148">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p167945459710">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="ShowGaussMySqlJobInfo__b12235174213319">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="ShowGaussMySqlJobInfo__b724113426312">Z</strong> indicates the time zone offset.</p>
|
|
<p id="ShowGaussMySqlJobInfo__p17415219201419">The value is empty unless the DB instance creation is complete.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row134128196142"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p104151819121419">ended</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p1441581918146">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p19541163020915">End time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="ShowGaussMySqlJobInfo__b6565155819320">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="ShowGaussMySqlJobInfo__b11565558832">Z</strong> indicates the time zone offset.</p>
|
|
<p id="ShowGaussMySqlJobInfo__p441551981415">The value is empty unless the DB instance creation is complete.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row10412219121417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p1141512197140">process</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p13415101913141">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p1141511961418">Task execution progress. The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, <strong id="ShowGaussMySqlJobInfo__b1833450551104835">""</strong> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row164126198142"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p4415141914144">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p154161219121417"><a href="#ShowGaussMySqlJobInfo__response_GetJobInstanceInfoDetail">GetJobInstanceInfoDetail</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p14416181918144">DB instance information of the task with the specified ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row1241221931413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p20416131921418">entities</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p104161319171411">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p341641920147">Displayed information varies depending on tasks.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row94121619161418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p641671951418">fail_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p15416619161410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.4.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p6416171921418">Task failure information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="ShowGaussMySqlJobInfo__response_GetJobInstanceInfoDetail"></a><a name="response_GetJobInstanceInfoDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__response_GetJobInstanceInfoDetail" frame="border" border="1" rules="all"><caption><b>Table 6 </b>GetJobInstanceInfoDetail</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row114171719101411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="ShowGaussMySqlJobInfo__p1441781971416">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="ShowGaussMySqlJobInfo__p1341751914143">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="ShowGaussMySqlJobInfo__p1341713198142">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowGaussMySqlJobInfo__row44171019111415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p5417131941415">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p1541761914146">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p1041891961420">DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row16417101910143"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p19418191921416">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p84181119131416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p10418141919147">DB instance name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowGaussMySqlJobInfo__p19418131913145"><strong id="ShowGaussMySqlJobInfo__b441891918140">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row34181319151419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="ShowGaussMySqlJobInfo__p10418181920141">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="ShowGaussMySqlJobInfo__p1741918196149">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="ShowGaussMySqlJobInfo__p1541918197142">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowGaussMySqlJobInfo__row13418201921413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p19419121915141">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p6419419121413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p11419121910142">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row174181519191414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p9419101991411">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p8419111911145">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p17419161901420">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowGaussMySqlJobInfo__p1041961920142"><strong id="ShowGaussMySqlJobInfo__b1541921921411">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowGaussMySqlJobInfo__table13420181991411" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ShowGaussMySqlJobInfo__row1542031911145"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="ShowGaussMySqlJobInfo__p34201719141413">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="ShowGaussMySqlJobInfo__p1042051931417">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="ShowGaussMySqlJobInfo__p642014192142">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowGaussMySqlJobInfo__row104207195146"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p1442011981416">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p1842081910144">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p1142117199144">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowGaussMySqlJobInfo__row042091901413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="ShowGaussMySqlJobInfo__p1742101918148">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="ShowGaussMySqlJobInfo__p1842141991419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="ShowGaussMySqlJobInfo__p14217193149">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowGaussMySqlJobInfo__section442111194141"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="ShowGaussMySqlJobInfo__screen1579213421056">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514</pre>
|
|
</div>
|
|
<div class="section" id="ShowGaussMySqlJobInfo__section17941696154"><h4 class="sectiontitle">Example Response</h4><p id="ShowGaussMySqlJobInfo__p189411916158"><strong id="ShowGaussMySqlJobInfo__b119409171516">Status code: 200</strong></p>
|
|
<div class="note" id="ShowGaussMySqlJobInfo__note10942971520"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="ShowGaussMySqlJobInfo__p194189131510">In the response example, some tasks in the task center are used as examples.</p>
|
|
</div></div>
|
|
<p id="ShowGaussMySqlJobInfo__p12942991511">Success.</p>
|
|
<pre class="screen" id="ShowGaussMySqlJobInfo__screen1194892153">{
|
|
"job" : {
|
|
"id" : "a9767ede-fe0f-4888-9003-e843a4c90514",
|
|
"name" : "CreateMysqlInstance",
|
|
"status" : "Completed",
|
|
"created" : "2018-08-06T10:41:14+0800",
|
|
"ended" : "2018-08-06T16:41:14+0000",
|
|
"process" : "",
|
|
"instance" : {
|
|
"id" : "a48e43ff268f4c0e879652d65e63d0fbin07",
|
|
"name" : "DO-NOT-TOUCH-mgr2-mysql-single"
|
|
},
|
|
"entities" : {
|
|
"instance" : {
|
|
"endpoint" : "192.168.1.203:3306",
|
|
"type" : "Cluster",
|
|
"datastore" : {
|
|
"type" : "gaussdb-mysql",
|
|
"version" : "8.0"
|
|
}
|
|
},
|
|
"resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ]
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowGaussMySqlJobInfo__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="ShowGaussMySqlJobInfo__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="ShowGaussMySqlJobInfo__section2557116171718"><h4 class="sectiontitle">Error Code</h4><p id="ShowGaussMySqlJobInfo__p855716160178">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_04_0014.html">Task Center</a></div>
|
|
</div>
|
|
</div>
|
|
|