forked from docs/doc-exports
wangdengke2
1ddaec1a62
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
500 lines
35 KiB
HTML
500 lines
35 KiB
HTML
<a name="rds_13_0003"></a><a name="rds_13_0003"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Information About a Task with a Specified ID</h1>
|
|
<div id="body1535613843473"><div class="section" id="rds_13_0003__section6603527917262"><h4 class="sectiontitle">Function</h4><p id="rds_13_0003__p4725737717262">This API is used to obtain information about a task with a specified ID in the task center.</p>
|
|
<ul id="rds_13_0003__ul12259155218373"><li id="rds_13_0003__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_13_0003__en-us_topic_0240111818_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0003__section1995103535418"><h4 class="sectiontitle">Constraints</h4><ul id="rds_13_0003__ul66159397195852"><li id="rds_13_0003__li10368133064214">RDS jobs are asynchronous. After a job is generated, it takes several seconds to query the job ID.</li><li id="rds_13_0003__li2772628195851">This API is used to query only asynchronous tasks in the task center within one month.</li><li id="rds_13_0003__li0583183318127">Information of the following asynchronous tasks can be obtained: creating single or primary/standby DB instances, creating read replicas, changing single DB instances to primary/standby instances, switching primary/standby DB instances, scaling up storage space, and binding or unbinding EIPs.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0003__section47568069103438"><h4 class="sectiontitle">URI</h4><ul id="rds_13_0003__ul16391217184115"><li id="rds_13_0003__li363951734111">URI format<p id="rds_13_0003__p1363971724110"><a name="rds_13_0003__li363951734111"></a><a name="li363951734111"></a>GET https://{<em id="rds_13_0003__i155911241191710">Endpoint</em>}/v3/{project_id}/jobs?id={id}</p>
|
|
</li></ul>
|
|
<ul id="rds_13_0003__ul27808384103438"><li id="rds_13_0003__li48916315103438">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0003__table37593651103438" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_13_0003__row58913670103438"><th align="left" class="cellrowborder" valign="top" width="23.45%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_13_0003__p7277976103438"><strong id="rds_13_0003__b755175182210">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.360000000000003%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_13_0003__p52645207103438"><strong id="rds_13_0003__b75614522215">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.19%" id="mcps1.3.3.3.1.1.2.4.1.3"><p id="rds_13_0003__p36403370103438"><strong id="rds_13_0003__b1056115192216">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0003__row62991866103438"><td class="cellrowborder" valign="top" width="23.45%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_13_0003__p902364145258">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.360000000000003%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_13_0003__p5982632145258">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.19%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_13_0003__p14831209145258">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_13_0003__p19455113121011">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row64285464517"><td class="cellrowborder" valign="top" width="23.45%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_13_0003__p74292461953">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.360000000000003%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_13_0003__p60181840">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.19%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_13_0003__p16429184614514">Specifies the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0003__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_13_0003__ul1183180183717"><li id="rds_13_0003__li1283110163719">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0003__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_13_0003__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_13_0003__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_13_0003__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_13_0003__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_13_0003__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0003__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_13_0003__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_13_0003__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_13_0003__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_13_0003__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_13_0003__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_13_0003__ul1082714265612"><li id="rds_13_0003__li4411135064210">Example<p id="rds_13_0003__p1454414211213"><a name="rds_13_0003__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0003__section4828447917262"><h4 class="sectiontitle">Response</h4><ul id="rds_13_0003__ul1872869017262"><li id="rds_13_0003__li3434049017262">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0003__table12268582117" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="rds_13_0003__row1322618515214"><th align="left" class="cellrowborder" valign="top" width="24.97%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_13_0003__p937961932115"><strong id="rds_13_0003__b1029710578359">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.94%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_13_0003__p6379219132116"><strong id="rds_13_0003__b393951011304">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.09%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_13_0003__p12379121902117"><strong id="rds_13_0003__b1241341163011">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0003__row52274542119"><td class="cellrowborder" valign="top" width="24.97%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_13_0003__p22270502110">job</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.94%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_13_0003__p222712518214">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.09%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_13_0003__p1122713522111">Indicates the task information. For details, see <a href="#rds_13_0003__table54571314103317">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0003__table54571314103317"></a><a name="table54571314103317"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0003__table54571314103317" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Job field data structure description</caption><thead align="left"><tr id="rds_13_0003__row3459121463318"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="rds_13_0003__p91816414334"><strong id="rds_13_0003__b0591253228">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="rds_13_0003__p123216414335"><strong id="rds_13_0003__b19591650227">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="rds_13_0003__p440144113310"><strong id="rds_13_0003__b1593518220">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0003__row16459161403314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0003__p12459414153315">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0003__p945941483315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0003__p10459614163315">Indicates the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row2367713135211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0003__p2036712135529">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0003__p1136761311525">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0003__p3367141316527">Indicates the task name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row98211748533"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0003__p11821164185319">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0003__p178212410537">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0003__p20821194165310">Indicates the task execution status.</p>
|
|
<div class="p" id="rds_13_0003__p12167194625317">Value:<ul id="rds_13_0003__ul1116724610533"><li id="rds_13_0003__li4183164614535"><strong id="rds_13_0003__b84235270616558">Running</strong>: The task is being executed.</li><li id="rds_13_0003__li6183146185311"><strong id="rds_13_0003__b842352706165522">Completed</strong>: The task is successfully executed.</li><li id="rds_13_0003__li17183746115312"><strong id="rds_13_0003__b842352706165534">Failed</strong>: The task fails to be executed.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row8137184445520"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0003__p1137944165511">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0003__p10137164414554">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0003__p740512805712">Indicates the creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="rds_13_0003__p174057816579"><strong id="rds_13_0003__b8621751222">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_13_0003__b262105192214">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row71317215715"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0003__p61342179">ended</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0003__p131392777">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0003__p26452251171">Indicates the end time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="rds_13_0003__p164512251074"><strong id="rds_13_0003__b842352706151812">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_13_0003__b842352706153833">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row113911711165717"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0003__p183911211105719">process</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0003__p1839115119578">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0003__p739131112579">Indicates the task execution progress.</p>
|
|
<div class="note" id="rds_13_0003__note93961953175813"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_13_0003__p11412175314581">The execution progress (such as <strong id="rds_13_0003__b283720117365">"60"</strong>, indicating the task execution progress is 60%) is displayed only when the task is being executed. Otherwise, <strong id="rds_13_0003__b13748476559426">""</strong> is returned.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row38251071027"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0003__p782547326">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0003__p12825171522">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0003__p148251371722">Indicates information of the DB instance on which the task is executed.</p>
|
|
<p id="rds_13_0003__p176261414190">For details, see <a href="#rds_13_0003__table4062895917262">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row5281748549"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0003__p15281144816414">entities</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0003__p828117481940">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0003__p152810481047">The displayed information varies depending on the tasks.</p>
|
|
<p id="rds_13_0003__p597415316194">For details, see <a href="#rds_13_0003__table1014617554138">Table 6</a>.</p>
|
|
<div class="note" id="rds_13_0003__note1546714962017"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_13_0003__p9467189102011">For asynchronous tasks without the <strong id="rds_13_0003__b842352706173418">entities</strong> field description, <strong id="rds_13_0003__b842352706173445">{}</strong> is returned.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row135472431958"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0003__p1954711436518">fail_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0003__p95478437512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0003__p1654711431756">Indicates the error information displayed when a task failed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0003__table4062895917262"></a><a name="table4062895917262"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0003__table4062895917262" frame="border" border="1" rules="all"><caption><b>Table 5 </b>instances field data structure description</caption><thead align="left"><tr id="rds_13_0003__row2045312717262"><th align="left" class="cellrowborder" valign="top" width="23.527647235276476%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="rds_13_0003__p4609059717262"><strong id="rds_13_0003__b16735172217">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.36686331366863%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="rds_13_0003__p4235091617262"><strong id="rds_13_0003__b12682552217">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.1054894510549%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="rds_13_0003__p787220417262"><strong id="rds_13_0003__b26816562217">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0003__row3366877217262"><td class="cellrowborder" valign="top" width="23.527647235276476%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="rds_13_0003__p4281598817262">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.36686331366863%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="rds_13_0003__p4554301317262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.1054894510549%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="rds_13_0003__p6510543817262">Indicates the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row964613217262"><td class="cellrowborder" valign="top" width="23.527647235276476%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="rds_13_0003__p4313926117262">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.36686331366863%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="rds_13_0003__p461925817262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.1054894510549%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="rds_13_0003__p3861563617262">Indicates the DB instance name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0003__table1014617554138"></a><a name="table1014617554138"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0003__table1014617554138" frame="border" border="1" rules="all"><caption><b>Table 6 </b>entities field data structure description</caption><thead align="left"><tr id="rds_13_0003__row81461455201310"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="rds_13_0003__p1014655516139"><strong id="rds_13_0003__b76975192219">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="rds_13_0003__p4162655101313"><strong id="rds_13_0003__b1170850226">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="rds_13_0003__p12162105561317"><strong id="rds_13_0003__b117016542211">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0003__row9162185517134"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0003__p616225516136">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0003__p01623557138">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0003__p1716255591313">Indicates the information required for creating an instance, changing a single instance to primary/standby, or creating a read replica.</p>
|
|
<p id="rds_13_0003__p16631938113020">For details, see <a href="#rds_13_0003__table975183423611">Table 7</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row1516215514138"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0003__p71781255151318">resource_ids</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0003__p817875511311">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0003__p7178155521312">Indicates the queried resource ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row853105253015"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0003__p578815143119">volume</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0003__p187889517315">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0003__p3788859310">Indicates the resized disk information.</p>
|
|
<p id="rds_13_0003__p14788155163112">For details, see <a href="#rds_13_0003__table624912591398">Table 9</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row15774125253012"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0003__p1596601613312">public_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0003__p129661165317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0003__p99661016153114">Indicates the EIP implemented by the task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row18515102017316"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0003__p929312335312">switch_strategy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0003__p1293203333113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0003__p10293633143113">Indicates the primary/standby switchover policy.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0003__table975183423611"></a><a name="table975183423611"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0003__table975183423611" frame="border" border="1" rules="all"><caption><b>Table 7 </b>entities.instance field data structure description</caption><thead align="left"><tr id="rds_13_0003__row576603417366"><th align="left" class="cellrowborder" valign="top" width="23.762376237623766%" id="mcps1.3.5.2.1.5.2.4.1.1"><p id="rds_13_0003__p15782934123618"><strong id="rds_13_0003__b1672255228">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.7029702970297%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="rds_13_0003__p1978243473620"><strong id="rds_13_0003__b37219592211">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.53465346534653%" id="mcps1.3.5.2.1.5.2.4.1.3"><p id="rds_13_0003__p19782113413362"><strong id="rds_13_0003__b187205202213">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0003__row14782133414367"><td class="cellrowborder" valign="top" width="23.762376237623766%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="rds_13_0003__p1079713453618">endpoint</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="rds_13_0003__p1279743463620">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="rds_13_0003__p1379773419364">Indicates the DB instance connection address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row127971434193613"><td class="cellrowborder" valign="top" width="23.762376237623766%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="rds_13_0003__p138135341363">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="rds_13_0003__p68130343364">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="rds_13_0003__p17244141913456">Indicates the DB instance type.</p>
|
|
<ul id="rds_13_0003__ul59901239114615"><li id="rds_13_0003__li13990183994610"><strong id="rds_13_0003__b169317935319">Single</strong>: single-node instance</li><li id="rds_13_0003__li299093917468"><strong id="rds_13_0003__b1657971411536">Ha</strong>: primary/standby instance</li><li id="rds_13_0003__li199011396463"><strong id="rds_13_0003__b0985017145310">Replica</strong>: read replica</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row765018449559"><td class="cellrowborder" valign="top" width="23.762376237623766%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="rds_13_0003__p106501444165514">datastore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="rds_13_0003__p156507445552">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="rds_13_0003__p1261414318189">Indicates the database information. For details, see <a href="#rds_13_0003__table173094268581">Table 8</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row065719580010"><td class="cellrowborder" valign="top" width="23.762376237623766%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="rds_13_0003__p7657125811020">replica_of</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="rds_13_0003__p5657058607">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="rds_13_0003__p181921914311">Indicates the primary DB instance ID. This parameter is returned only when a read replica is created.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0003__table173094268581"></a><a name="table173094268581"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0003__table173094268581" frame="border" border="1" rules="all"><caption><b>Table 8 </b>datastore field data structure description</caption><thead align="left"><tr id="rds_13_0003__row153243260580"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.6.2.4.1.1"><p id="rds_13_0003__p11324142645814"><strong id="rds_13_0003__b187512582217">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.5.2.1.6.2.4.1.2"><p id="rds_13_0003__p1533910267583"><strong id="rds_13_0003__b19759582216">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.5.2.1.6.2.4.1.3"><p id="rds_13_0003__p3339526125813"><strong id="rds_13_0003__b157514532219">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0003__row0339102625817"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="rds_13_0003__p1833918260580">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.6.2.4.1.2 "><p id="rds_13_0003__p3356182625820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.6.2.4.1.3 "><p id="rds_13_0003__p163562026185813">Indicates the DB engine.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row1335614267583"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.6.2.4.1.1 "><p id="rds_13_0003__p16356132625815">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.6.2.4.1.2 "><p id="rds_13_0003__p3356162665817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.6.2.4.1.3 "><p id="rds_13_0003__p1437111268582">Indicates the database version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0003__table624912591398"></a><a name="table624912591398"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0003__table624912591398" frame="border" border="1" rules="all"><caption><b>Table 9 </b>volume field data structure description</caption><thead align="left"><tr id="rds_13_0003__row1526545915917"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.7.2.4.1.1"><p id="rds_13_0003__p026555914920"><strong id="rds_13_0003__b879850229">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.5.2.1.7.2.4.1.2"><p id="rds_13_0003__p22657595911"><strong id="rds_13_0003__b3801358225">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.5.2.1.7.2.4.1.3"><p id="rds_13_0003__p20280125917911"><strong id="rds_13_0003__b1280115122216">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0003__row628020591792"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="rds_13_0003__p122803593917">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="rds_13_0003__p229719593916">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><p id="rds_13_0003__p12979591199">Indicates the volume type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row1829725910918"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="rds_13_0003__p1729713591493">original_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="rds_13_0003__p1431115917919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><p id="rds_13_0003__p4311759893">Indicates the original volume size in GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0003__row14459456111318"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.7.2.4.1.1 "><p id="rds_13_0003__p1459155691316">target_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.5.2.1.7.2.4.1.2 "><p id="rds_13_0003__p4459256171317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.5.2.1.7.2.4.1.3 "><p id="rds_13_0003__p1645925616135">Indicates the target volume size in GB.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="rds_13_0003__note3482053511312"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="rds_13_0003__p4494936511312">In the response example, some tasks in the task center are used as examples.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
<ul id="rds_13_0003__ul2705380172618"><li id="rds_13_0003__li24348422172618">Example normal response<div class="p" id="rds_13_0003__p17809214172618"><a name="rds_13_0003__li24348422172618"></a><a name="li24348422172618"></a>Creating a DB instance:<pre class="screen" id="rds_13_0003__screen41057471291">{
|
|
"job": {
|
|
"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
|
|
"name": "CreateMysqlSingleHAInstance",
|
|
"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-mysql-single"
|
|
},
|
|
"entities": {
|
|
"instance": {
|
|
"endpoint": "192.168.1.203:3306",
|
|
"type": "Single",
|
|
"datastore": {
|
|
"type": "mysql",
|
|
"version": "5.7"
|
|
}
|
|
},
|
|
"resource_ids": ["a48e43ff268f4c0e879652d65e63d0fbin01.vm", "a48e43ff268f4c0e879652d65e63d0fbin01.volume"]
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="rds_13_0003__p3495127112212">Creating a read replica:<pre class="screen" id="rds_13_0003__screen11466132081013">{
|
|
"job": {
|
|
"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
|
|
"name": " CreateMysqlReplicaInstance",
|
|
"status": "Completed",
|
|
"created": "2018-08-06T10:41:14+0000",
|
|
"ended": "2018-08-06T16:41:14+0000",
|
|
"process": "",
|
|
"instance": {
|
|
"id": "288caaa9d05f4ec1a1f58de2e0945685in01",
|
|
"name": "mysql-replica"
|
|
},
|
|
"entities": {
|
|
"instance": {
|
|
"endpoint": "192.168.1.203:3306",
|
|
"type": "replica",
|
|
"datastore": {
|
|
"type": "mysql",
|
|
"version": "5.7"
|
|
},
|
|
"replica_of": "a48e43ff268f4c0e879652d65e63d0fbin01"
|
|
},
|
|
"resource_ids": ["288caaa9d05f4ec1a1f58de2e0945685in01.vm", "288caaa9d05f4ec1a1f58de2e0945685in01.volume"]
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="rds_13_0003__p16341133218225">Binding an EIP:<pre class="screen" id="rds_13_0003__screen68381101115">{
|
|
"job": {
|
|
"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
|
|
"name": "MysqlBindEIP",
|
|
"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-mysql-single"
|
|
},
|
|
"entities": {
|
|
"public_ip": "10.10.10.1"
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="rds_13_0003__p2998203292310">Rebooting a DB instance:<pre class="screen" id="rds_13_0003__screen196648193114">{
|
|
"job": {
|
|
"id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
|
|
"name": " RestartMysqlInstance",
|
|
"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-mysql-single"
|
|
},
|
|
"entities": {}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="rds_13_0003__p11795853102318">Task being executed:<pre class="screen" id="rds_13_0003__screen89591240151112">{
|
|
"job": {
|
|
"id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886",
|
|
"name": "CreateMysqlSingleHAInstance"," status": "Running",
|
|
"created": "2018-08-06T10:41:14+0000",
|
|
"process": "60% ",
|
|
"instance": {
|
|
"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
|
|
"name": "DO-NOT-TOUCH-mgr2-mysql-single"
|
|
},
|
|
"entities": {
|
|
"instance": {
|
|
"type": "Single",
|
|
"datastore": {
|
|
"type": "mysql",
|
|
"version": "5.7"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="rds_13_0003__p679519536239">Task fails to be executed:<pre class="screen" id="rds_13_0003__screen4981116201214">{
|
|
"job": {
|
|
"id": "31 b8ae23 - c687 - 4 d80 - b7b4 - 42 a66c9bb886",
|
|
"name": "CreateMysqlSingleHAInstance",
|
|
"status": "Failed",
|
|
"created": "2018-08-06T10:41:14+0000",
|
|
"ended": "2018-08-06T16:41:14+0000",
|
|
"process": "",
|
|
"instance": {
|
|
"id": "a48e43ff268f4c0e879652d65e63d0fbin01",
|
|
"name": "DO-NOT-TOUCH-mgr2-mysql-single"
|
|
},
|
|
"entities": {
|
|
"instance": {
|
|
"type": "Single",
|
|
"datastore": {
|
|
"type": "mysql",
|
|
"version": "5.7"
|
|
}
|
|
}
|
|
},
|
|
"fail_reason": "createVM failed."
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</li><li id="rds_13_0003__li1327139149">Abnormal Response<p id="rds_13_0003__p37177336172618"><a name="rds_13_0003__li1327139149"></a><a name="li1327139149"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0003__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_13_0003__en-us_topic_0032347778_ul7858132212142"><li id="rds_13_0003__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_13_0003__en-us_topic_0032347778_p1040982941020"><a name="rds_13_0003__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_13_0003__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_13_0003__en-us_topic_0032347778_p0723374409"><a name="rds_13_0003__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0003__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_13_0003__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_13_0000.html">Obtaining Task Information</a></div>
|
|
</div>
|
|
</div>
|
|
|