forked from docs/doc-exports
wangdengke2
1aae9268b0
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
402 lines
32 KiB
HTML
402 lines
32 KiB
HTML
<a name="gaussdb_11_0032"></a><a name="gaussdb_11_0032"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Information About a Task with a Specified ID</h1>
|
|
<div id="body8662426"><div class="section" id="gaussdb_11_0032__en-us_topic_0000001251304374_section6603527917262"><h4 class="sectiontitle">Function</h4><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p4725737717262">This API is used to obtain information about a TaurusDB task with a specified ID in the task center. Before calling this API:</p>
|
|
<ul id="gaussdb_11_0032__en-us_topic_0000001251304374_ul924420236520"><li id="gaussdb_11_0032__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0032__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0032__en-us_topic_0000001251304374_section47568069103438"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0032__en-us_topic_0000001251304374_ul16391217184115"><li id="gaussdb_11_0032__en-us_topic_0000001251304374_li363951734111">URI format<p id="gaussdb_11_0032__en-us_topic_0000001251304374_p1363971724110"><a name="gaussdb_11_0032__en-us_topic_0000001251304374_li363951734111"></a><a name="en-us_topic_0000001251304374_li363951734111"></a>GET https://{endpoint}/mysql/v3/{project_id}/jobs?id={id}</p>
|
|
</li><li id="gaussdb_11_0032__en-us_topic_0000001251304374_li4411135064210">URI example<p id="gaussdb_11_0032__p49881244162310"><a name="gaussdb_11_0032__en-us_topic_0000001251304374_li4411135064210"></a><a name="en-us_topic_0000001251304374_li4411135064210"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514</p>
|
|
</li></ul>
|
|
<ul id="gaussdb_11_0032__en-us_topic_0000001251304374_ul27808384103438"><li id="gaussdb_11_0032__en-us_topic_0000001251304374_li48916315103438">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__en-us_topic_0000001251304374_table37593651103438" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0032__en-us_topic_0000001251304374_row58913670103438"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p7277976103438"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b1917540175915">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.29%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p52645207103438">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.28%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p36403370103438"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b12726174215914">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__en-us_topic_0000001251304374_row62991866103438"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p902364145258">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.29%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p5982632145258">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.28%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p14831209145258">Project ID of a tenant in a region.</p>
|
|
<p id="gaussdb_11_0032__en-us_topic_0000001251304374_p19455113121011">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__en-us_topic_0000001251304374_row64285464517"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p74292461953">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.29%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p60181840">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.28%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="gaussdb_11_0032__en-us_topic_0000001251304374_p16429184614514">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0032__section534331225112"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__en-us_topic_0000001181084222_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_11_0032__row3344141210514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_11_0032__p63444127519">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="gaussdb_11_0032__p2344512155110">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="gaussdb_11_0032__p1334531214516">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="gaussdb_11_0032__p1734531219517">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row334414121516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0032__p83451512115111">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0032__p19345181285117">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0032__p83461912185113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0032__p73461212145112">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row2344111214512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0032__p034671214511">X-Language</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0032__p3346171235119">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0032__p4347161217519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0032__p134711128511">Language.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row151561025184114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0032__p15665114311157">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0032__p36651643101518">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0032__p10665443181514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0032__p1866504318159">MIME type of the request body. You are advised to use the default value <strong id="gaussdb_11_0032__b3449422168">application/json</strong>. For APIs used to upload objects or images, the value can vary depending on the flow type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0032__section1334715122517"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_11_0032__p1534891255118"><strong id="gaussdb_11_0032__b18994428164">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__en-us_topic_0000001181084222_response_GetJobInfoResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0032__row16348111235114"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_11_0032__p193488124517">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="gaussdb_11_0032__p13349161211513">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="gaussdb_11_0032__p1234901213518">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row16348131265113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_11_0032__p134991295116">job</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_11_0032__p73497128511"><a href="#gaussdb_11_0032__en-us_topic_0000001181084222_response_GetJobInfoDetail">GetJobInfoDetail</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_11_0032__p93502128513">Task information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="gaussdb_11_0032__en-us_topic_0000001181084222_response_GetJobInfoDetail"></a><a name="en-us_topic_0000001181084222_response_GetJobInfoDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__en-us_topic_0000001181084222_response_GetJobInfoDetail" frame="border" border="1" rules="all"><caption><b>Table 4 </b>GetJobInfoDetail</caption><thead align="left"><tr id="gaussdb_11_0032__row4350121216513"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_11_0032__p1635151219515">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="gaussdb_11_0032__p935161218514">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="gaussdb_11_0032__p1735110124512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row10350171217513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0032__p7351151212514">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0032__p1835211235115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0032__p135221218515">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row163501121515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0032__p135210127514">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0032__p0352171265118">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0032__p7353712195115">Task name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row1135021245110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0032__p1135341245119">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0032__p1535315129513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0032__p20821194165310">Task execution status.</p>
|
|
<div class="p" id="gaussdb_11_0032__p12167194625317">Valid value:<ul id="gaussdb_11_0032__ul1116724610533"><li id="gaussdb_11_0032__li4183164614535"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b84235270616558">Running</strong>: The task is being executed.</li><li id="gaussdb_11_0032__li6183146185311"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b842352706165522">Completed</strong>: The task is successfully executed.</li><li id="gaussdb_11_0032__li17183746115312"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b842352706165534">Failed</strong>: The task fails to be executed.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row1635081245110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0032__p133573124512">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0032__p15357131217513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0032__p548175764217">Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="gaussdb_11_0032__p72617519437"><strong id="gaussdb_11_0032__b085095121617">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_11_0032__b12855105121620">Z</strong> indicates the time zone offset.</p>
|
|
<p id="gaussdb_11_0032__p19357191220519">The value is empty unless the instance creation is complete.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row135001225112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0032__p93582012135115">ended</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0032__p1535819120511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0032__p20715181419437">End time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="gaussdb_11_0032__p115396226432"><strong id="gaussdb_11_0032__b847420131718">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_11_0032__b1475100191712">Z</strong> indicates the time zone offset.</p>
|
|
<p id="gaussdb_11_0032__p63582012135119">The value is empty unless the instance creation is complete.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row143508122518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0032__p1935810129516">process</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0032__p43591412195114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0032__p9359812105110">Task execution progress. The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, <strong id="gaussdb_11_0032__b12213998176">""</strong> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row17350612165118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0032__p5359141225114">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0032__p13598125511"><a href="#gaussdb_11_0032__en-us_topic_0000001181084222_response_GetJobInstanceInfoDetail">GetJobInstanceInfoDetail</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0032__p036015128513">Instance information of the task with the specified ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row173501912145114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0032__p936091220517">entities</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0032__p0360512135118"><a href="#gaussdb_11_0032__table1014617554138">Table 6</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0032__p14360121225115">Displayed information varies depending on tasks.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row335011120518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0032__p19361412145117">fail_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0032__p1736161215110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0032__p1136112122511">Task failure information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="gaussdb_11_0032__en-us_topic_0000001181084222_response_GetJobInstanceInfoDetail"></a><a name="en-us_topic_0000001181084222_response_GetJobInstanceInfoDetail"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__en-us_topic_0000001181084222_response_GetJobInstanceInfoDetail" frame="border" border="1" rules="all"><caption><b>Table 5 </b>GetJobInstanceInfoDetail</caption><thead align="left"><tr id="gaussdb_11_0032__row1336151219516"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="gaussdb_11_0032__p143621612205110">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="gaussdb_11_0032__p43621912175120">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="gaussdb_11_0032__p183621612185120">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row1936191265110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0032__p183639123513">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0032__p1436319123517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0032__p236311216513">DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row1736118127513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0032__p1336314125515">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0032__p16364161218518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0032__p836491210518">DB instance name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="gaussdb_11_0032__table1014617554138"></a><a name="table1014617554138"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__table1014617554138" frame="border" border="1" rules="all"><caption><b>Table 6 </b>entities field data structure description</caption><thead align="left"><tr id="gaussdb_11_0032__row81461455201310"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.6.2.4.1.1"><p id="gaussdb_11_0032__p1014655516139"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b12331750132118">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.4.6.2.4.1.2"><p id="gaussdb_11_0032__p4162655101313">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.4.6.2.4.1.3"><p id="gaussdb_11_0032__p12162105561317"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b1470425082118">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row9162185517134"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_11_0032__p616225516136">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_11_0032__p01623557138">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_11_0032__p1716255591313">DB instance queried in the task.</p>
|
|
<p id="gaussdb_11_0032__p34731051101811">For details, see <a href="#gaussdb_11_0032__table975183423611">Table 7</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row1516215514138"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_11_0032__p71781255151318">resource_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_11_0032__p817875511311">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_11_0032__p7178155521312">Resource ID involved in a task.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="gaussdb_11_0032__table975183423611"></a><a name="table975183423611"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__table975183423611" frame="border" border="1" rules="all"><caption><b>Table 7 </b>entities.instance field data structure description</caption><thead align="left"><tr id="gaussdb_11_0032__row576603417366"><th align="left" class="cellrowborder" valign="top" width="23.762376237623762%" id="mcps1.3.4.7.2.4.1.1"><p id="gaussdb_11_0032__p15782934123618"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b18660334102317">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.7029702970297%" id="mcps1.3.4.7.2.4.1.2"><p id="gaussdb_11_0032__p1978243473620">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.53465346534653%" id="mcps1.3.4.7.2.4.1.3"><p id="gaussdb_11_0032__p19782113413362"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b183469352235">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row14782133414367"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0032__p1079713453618">endpoint</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0032__p1279743463620">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0032__p1379773419364">DB instance connection address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row127971434193613"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0032__p138135341363">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0032__p68130343364">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0032__p17813163410363">DB instance type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row765018449559"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0032__p106501444165514">datastore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0032__p156507445552">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0032__p1261414318189">DB information. For details, see <a href="#gaussdb_11_0032__table173094268581">Table 8</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="gaussdb_11_0032__table173094268581"></a><a name="table173094268581"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__table173094268581" frame="border" border="1" rules="all"><caption><b>Table 8 </b>datastore field data structure description</caption><thead align="left"><tr id="gaussdb_11_0032__row153243260580"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.8.2.4.1.1"><p id="gaussdb_11_0032__p11324142645814"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b9301757192312">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.4.8.2.4.1.2"><p id="gaussdb_11_0032__p1533910267583">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.4.8.2.4.1.3"><p id="gaussdb_11_0032__p3339526125813"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b1546495813236">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row0339102625817"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0032__p1833918260580">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0032__p3356182625820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0032__p163562026185813">DB engine.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row1335614267583"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_11_0032__p16356132625815">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_11_0032__p3356162665817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_11_0032__p1437111268582">DB version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__table7391102412203" frame="border" border="1" rules="all"><caption><b>Table 9 </b>entities field data structure description (binding or unbinding an EIP)</caption><thead align="left"><tr id="gaussdb_11_0032__row83911224122019"><th align="left" class="cellrowborder" valign="top" width="23.527647235276476%" id="mcps1.3.4.9.2.4.1.1"><p id="gaussdb_11_0032__p15391192422011"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b291611242411">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.36686331366863%" id="mcps1.3.4.9.2.4.1.2"><p id="gaussdb_11_0032__p164051024152015">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.1054894510549%" id="mcps1.3.4.9.2.4.1.3"><p id="gaussdb_11_0032__p16405132422010"><strong id="gaussdb_11_0032__en-us_topic_0000001251304374_b14767101318244">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row54055240202"><td class="cellrowborder" valign="top" width="23.527647235276476%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_11_0032__p874812441918">public_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.36686331366863%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_11_0032__p1274812481916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.1054894510549%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_11_0032__p27481646197">EIP bound to the instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="gaussdb_11_0032__p103641012105110"><strong id="gaussdb_11_0032__b27171413172521">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__en-us_topic_0000001181084222_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0032__row4364812155119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="gaussdb_11_0032__p53659126518">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="gaussdb_11_0032__p936512129511">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="gaussdb_11_0032__p6365131255117">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row14364712105115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="gaussdb_11_0032__p123669125517">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="gaussdb_11_0032__p10366191217515">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="gaussdb_11_0032__p336610127513">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row6364112175115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="gaussdb_11_0032__p16366191217511">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="gaussdb_11_0032__p8367101216518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="gaussdb_11_0032__p3367101212516">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="gaussdb_11_0032__p8367141217510"><strong id="gaussdb_11_0032__b3623881164027">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0032__table1036715123518" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0032__row113681212135112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="gaussdb_11_0032__p16368191210514">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="gaussdb_11_0032__p10369161285113">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="gaussdb_11_0032__p43691512185116">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="gaussdb_11_0032__row2036814128517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="gaussdb_11_0032__p43695128516">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="gaussdb_11_0032__p936901275110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="gaussdb_11_0032__p137091285110">Error code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="gaussdb_11_0032__row1336851235117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="gaussdb_11_0032__p2370161218513">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="gaussdb_11_0032__p3370112155110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="gaussdb_11_0032__p8370171225116">Error message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0032__section10233434162015"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_11_0032__screen780252392411">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514</pre>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0032__section23711112175117"><h4 class="sectiontitle">Example Response</h4><div class="note" id="gaussdb_11_0032__note3482053511312"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="gaussdb_11_0032__p4494936511312">In the response example, some tasks in the task center are used as examples.</p>
|
|
</div></div>
|
|
<p id="gaussdb_11_0032__p103711712115112"><strong id="gaussdb_11_0032__b137422572176">Status code: 200</strong></p>
|
|
<p id="gaussdb_11_0032__p637212128512">Success.</p>
|
|
<pre class="screen" id="gaussdb_11_0032__screen8372212115116">{
|
|
"job": {
|
|
"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
|
|
"name": " RestartGaussDBInstance",
|
|
"status": "Completed",
|
|
"created": "2018-08-06T10:41:14+0000",
|
|
"ended": "2018-08-06T16:41:14+0000",
|
|
"process": "",
|
|
"instance": {
|
|
"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
|
|
"name": "DO-NOT-TOUCH-mgr2-taurusdb"
|
|
},
|
|
"entities": {}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0032__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_11_0032__p4402820324">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="gaussdb_11_0032__section2557116171718"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_11_0032__p144152819324">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
<p id="gaussdb_11_0032__en-us_topic_0000001251304374_p1217534312358"></p>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_11_0000.html">APIs (Unavailable Soon)</a></div>
|
|
</div>
|
|
</div>
|
|
|