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>
433 lines
33 KiB
HTML
433 lines
33 KiB
HTML
<a name="rds_13_0004"></a><a name="rds_13_0004"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Task Information of a Specified DB Instance in a Specified Time Range (RDS for SQL Server)</h1>
|
|
<div id="body0000002474751278"><div class="section" id="rds_13_0004__section6603527917262"><h4 class="sectiontitle">Function</h4><p id="rds_13_0004__p4725737717262">This API is used to obtain the task information list of a specified SQL Server DB instance ID within a specified time range.</p>
|
|
<ul id="rds_13_0004__ul12259155218373"><li id="rds_13_0004__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_0004__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_0004__section1995103535418"><h4 class="sectiontitle">Constraints</h4><ul id="rds_13_0004__ul66159397195852"><li id="rds_13_0004__li2772628195851">This API is used to query asynchronous tasks of the last one month in the task center.</li><li id="rds_13_0004__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, creating automated or manual backups, restoring data to original, existing, or new DB instances.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0004__section47568069103438"><h4 class="sectiontitle">URI</h4><ul id="rds_13_0004__ul16391217184115"><li id="rds_13_0004__li363951734111">URI format<p id="rds_13_0004__p1363971724110"><a name="rds_13_0004__li363951734111"></a><a name="li363951734111"></a>GET https://{<em id="rds_13_0004__i155911241191710">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/tasklist/detail?start_time={start_time}&end_time={end_time}</p>
|
|
</li></ul>
|
|
<ul id="rds_13_0004__ul27808384103438"><li id="rds_13_0004__li48916315103438">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0004__table37593651103438" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_13_0004__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_0004__p7277976103438"><strong id="rds_13_0004__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_0004__p52645207103438"><strong id="rds_13_0004__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_0004__p36403370103438"><strong id="rds_13_0004__b1056115192216">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0004__row62991866103438"><td class="cellrowborder" valign="top" width="23.45%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_13_0004__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_0004__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_0004__p14831209145258">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_13_0004__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_0004__row10195112712587"><td class="cellrowborder" valign="top" width="23.45%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_13_0004__p74292461953">instance_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_0004__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_0004__p2195827135813">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row057362815586"><td class="cellrowborder" valign="top" width="23.45%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_13_0004__p61422841018">start_time</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_0004__p131429831018">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_0004__p111421184109">Start time in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row64285464517"><td class="cellrowborder" valign="top" width="23.45%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_13_0004__p139711318121010">end_time</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_0004__p19712188107">No</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_0004__p1697112188106">End time in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0004__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_13_0004__ul1183180183717"><li id="rds_13_0004__li1283110163719">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0004__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_13_0004__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_0004__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_0004__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_0004__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_0004__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0004__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_13_0004__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_0004__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_0004__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_0004__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_13_0004__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_0004__ul1082714265612"><li id="rds_13_0004__li4411135064210">Example<pre class="screen" id="rds_13_0004__screen1032533293415">GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/a48e43ff268f4c0e879652d65e63d0fbin01/tasklist/detail?start_time=1533423274000&end_time=1533823274000</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0004__section4828447917262"><h4 class="sectiontitle">Response</h4><ul id="rds_13_0004__ul1872869017262"><li id="rds_13_0004__li3434049017262">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0004__table12268582117" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_13_0004__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_0004__p937961932115"><strong id="rds_13_0004__b1029710578359">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.139999999999997%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_13_0004__p6379219132116"><strong id="rds_13_0004__b393951011304">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.89%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_13_0004__p12379121902117"><strong id="rds_13_0004__b1241341163011">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0004__row52274542119"><td class="cellrowborder" valign="top" width="24.97%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_13_0004__p22270502110">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_13_0004__p222712518214">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.89%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_13_0004__p1122713522111">Indicates the task information. For details, see <a href="rds_13_0003.html#rds_13_0003__table54571314103317">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row14666204811712"><td class="cellrowborder" valign="top" width="24.97%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_13_0004__en-us_topic_0172437480_p1255265793915">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.139999999999997%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_13_0004__en-us_topic_0172437480_p7552175723911">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.89%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_13_0004__p12666124813170">Indicates the total number of tasks.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0004__table54571314103317" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Jobs field data structure description</caption><thead align="left"><tr id="rds_13_0004__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_0004__p91816414334"><strong id="rds_13_0004__b0591253228">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.52%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="rds_13_0004__p123216414335"><strong id="rds_13_0004__b19591650227">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.48%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="rds_13_0004__p440144113310"><strong id="rds_13_0004__b1593518220">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0004__row16459161403314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p12459414153315">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p945941483315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p10459614163315">Indicates the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row2367713135211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p2036712135529">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p1136761311525">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p3367141316527">Indicates the task name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row98211748533"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p11821164185319">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p178212410537">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p20821194165310">Indicates the task execution status.</p>
|
|
<div class="p" id="rds_13_0004__p12167194625317">Value:<ul id="rds_13_0004__ul1116724610533"><li id="rds_13_0004__li4183164614535"><strong id="rds_13_0004__b84235270616558">Running</strong>: The task is being executed.</li><li id="rds_13_0004__li6183146185311"><strong id="rds_13_0004__b842352706165522">Completed</strong>: The task is successfully executed.</li><li id="rds_13_0004__li17183746115312"><strong id="rds_13_0004__b842352706165534">Failed</strong>: The task fails to be executed.</li></ul>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row8137184445520"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p1137944165511">created</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p10137164414554">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p740512805712">Indicates the creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="rds_13_0004__p174057816579"><strong id="rds_13_0004__b8621751222">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_13_0004__b262105192214">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row71317215715"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p61342179">ended</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p131392777">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p26452251171">Indicates the end time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="rds_13_0004__p164512251074"><strong id="rds_13_0004__b842352706151812">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_13_0004__b842352706153833">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row113911711165717"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p183911211105719">process</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p1839115119578">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p739131112579">Indicates the task execution progress.</p>
|
|
<div class="note" id="rds_13_0004__note93961953175813"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_13_0004__p11412175314581">The execution progress (such as <strong id="rds_13_0004__b283720117365">"60"</strong>, indicating the task execution progress is 60%) is displayed only when the task is being executed. Otherwise, <strong id="rds_13_0004__b13748476559426">""</strong> is returned.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row38251071027"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p782547326">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p12825171522">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p148251371722">Indicates information of the DB instance on which the task is executed.</p>
|
|
<p id="rds_13_0004__p176261414190">For details, see <a href="#rds_13_0004__table4062895917262">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row5281748549"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p3548831112113">task_detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p18548103132113">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p152810481047">The displayed information varies depending on the tasks.</p>
|
|
<p id="rds_13_0004__p597415316194">For details, see the following:</p>
|
|
<ul id="rds_13_0004__ul3554342192"><li id="rds_13_0004__li14504171918394"><a href="#rds_13_0004__table83091453182413">Table 6</a></li><li id="rds_13_0004__li57932367194"><a href="#rds_13_0004__table61193182619">Table 7</a></li></ul>
|
|
<div class="note" id="rds_13_0004__note1546714962017"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_13_0004__p9467189102011">This field is not displayed for asynchronous tasks that do not contain the <strong id="rds_13_0004__b111021751125612">task_detail</strong> field.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row135472431958"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p1954711436518">fail_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p95478437512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p1654711431756">Indicates the error information displayed when a task failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row13939621202119"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_13_0004__p15281144816414">entities</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.52%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_13_0004__p828117481940">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.48%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_13_0004__p9774115117220">The displayed information varies depending on the tasks.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0004__table4062895917262"></a><a name="table4062895917262"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0004__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_0004__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_0004__p4609059717262"><strong id="rds_13_0004__b16735172217">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.0969903009699%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="rds_13_0004__p4235091617262"><strong id="rds_13_0004__b12682552217">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.375362463753625%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="rds_13_0004__p787220417262"><strong id="rds_13_0004__b26816562217">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0004__row3366877217262"><td class="cellrowborder" valign="top" width="23.527647235276476%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="rds_13_0004__p4281598817262">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.0969903009699%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="rds_13_0004__p4554301317262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.375362463753625%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="rds_13_0004__p6510543817262">Indicates the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row964613217262"><td class="cellrowborder" valign="top" width="23.527647235276476%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="rds_13_0004__p4313926117262">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.0969903009699%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="rds_13_0004__p461925817262">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.375362463753625%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="rds_13_0004__p3861563617262">Indicates the DB instance name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0004__table83091453182413"></a><a name="table83091453182413"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0004__table83091453182413" frame="border" border="1" rules="all"><caption><b>Table 6 </b>task_detail field data structure description (restoring data to original, existing, or new DB instances, or restoring table-level data to a specified time point)</caption><thead align="left"><tr id="rds_13_0004__row6309953182414"><th align="left" class="cellrowborder" valign="top" width="23.762376237623762%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="rds_13_0004__p23091353172419"><strong id="rds_13_0004__b17702716171">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.7029702970297%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="rds_13_0004__p13309353132413"><strong id="rds_13_0004__b7004269849426">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.53465346534653%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="rds_13_0004__p0309195316246"><strong id="rds_13_0004__b2975118099426">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0004__row33097534247"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0004__p12893171417251">sourceInstanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0004__p15893131422516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0004__p1730905319241">Indicates the ID of the original DB instance to which backup data is restored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row831015342413"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0004__p1389311140250">targetInstanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0004__p168939141255">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0004__p15310205322410">Indicates the ID of the target DB instance to which backup data is restored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row1431025315245"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0004__p10893101412516">backupId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0004__p6893514172518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0004__p531095332411">Indicates the backup file ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row173101353162415"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0004__p16893514152511">restoreTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0004__p1089310148257">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0004__p18310125317241">Indicates the time point to which table-level data is restored.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row10582438123117"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0004__p13584537173119">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0004__p1958423718316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0004__p5584937133120">Indicates the task type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row63011303212"><td class="cellrowborder" valign="top" width="23.762376237623762%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_13_0004__p1933112133216">dbNames</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.7029702970297%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_13_0004__p815812213329">List<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.53465346534653%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_13_0004__p53316233216">Indicates the database name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0004__table61193182619"></a><a name="table61193182619"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0004__table61193182619" frame="border" border="1" rules="all"><caption><b>Table 7 </b>task_detail field data structure description (creating automated or manual backups)</caption><thead align="left"><tr id="rds_13_0004__row2011911112611"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.5.2.4.1.1"><p id="rds_13_0004__p151197182618"><strong id="rds_13_0004__b11384627183">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.630000000000003%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="rds_13_0004__p11192122618"><strong id="rds_13_0004__b5218202979426">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.37%" id="mcps1.3.5.2.1.5.2.4.1.3"><p id="rds_13_0004__p412091202610"><strong id="rds_13_0004__b2834604409426">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0004__row2120151182619"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="rds_13_0004__p1487125054715">instanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="rds_13_0004__p1412020172617">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.37%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="rds_13_0004__p112014192614">Indicates the ID of the DB instance to be backed up.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row1912014113262"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="rds_13_0004__p9120512261">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="rds_13_0004__p201208122615">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.37%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="rds_13_0004__p111201132616">Indicates the task name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row17225024135410"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="rds_13_0004__p13991622165413">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="rds_13_0004__p49919223544">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.37%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="rds_13_0004__p189917226543">Indicates the task description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0004__row12900104118542"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="rds_13_0004__p981211406547">dbNames</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.630000000000003%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="rds_13_0004__p781234065414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.37%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="rds_13_0004__p19812144013548">Indicates the name of the data to be backed up.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="rds_13_0004__note16149153013268"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="rds_13_0004__p1214953015263">In the response example, some returned task details are used as examples.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
<ul id="rds_13_0004__ul2705380172618"><li id="rds_13_0004__li24348422172618">Example normal response<p id="rds_13_0004__p12822173813280"><a name="rds_13_0004__li24348422172618"></a><a name="li24348422172618"></a>Creating automated or manual backups:</p>
|
|
<pre class="screen" id="rds_13_0004__screen228810117137">{
|
|
"jobs": [
|
|
{
|
|
"id": "aa4e3386-af27-436e-99f5-7cfefa21c37a",
|
|
"name": "BackupDbSqlserverInInstance",
|
|
"status": "Completed",
|
|
"created": "2020-07-20T16:10:07+0000",
|
|
"ended": "2020-07-20T16:14:39+0000",
|
|
"process": "",
|
|
"instance": {
|
|
"id": "9a09052dfa824caea36f583bc3e5684ein04",
|
|
"name": "rds-8d43-0004"
|
|
},
|
|
"task_detail": "{\"instanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\",\"name\":\"sqlserver-rds-8d43-0004-20200719161130675\"}"
|
|
}
|
|
],
|
|
"count":1
|
|
}</pre>
|
|
<div class="p" id="rds_13_0004__p78221938152815">Restoring data to original, existing, or new DB instances, or restoring table-level data to a specified time point:<pre class="screen" id="rds_13_0004__screen827411681316">{
|
|
"jobs": [
|
|
{
|
|
"id": "11bef2cb-2924-4727-a9c2-b6fec61fc03a",
|
|
"name": "SingleDbRestoreSqlserverInInstance",
|
|
"status": "Failed",
|
|
"created": "2020-07-21T01:38:00+0000",
|
|
"ended": "2020-07-21T01:39:59+0000",
|
|
"process": "",
|
|
"instance": {
|
|
"id": "9a09052dfa824caea36f583bc3e5684ein04",
|
|
"name": "rds-8d43-0004"
|
|
},
|
|
"task_detail": "{\"backupId\":\"83c76e6852c145779dc153d8299ee0e1br04\",\"dbNames\":\"backeeeeee\",\"sourceInstanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\",\"targetInstanceId\":\"9a09052dfa824caea36f583bc3e5684ein04\"}"
|
|
}
|
|
],
|
|
"count":1
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="rds_13_0004__p982213892816">Other task types:<pre class="screen" id="rds_13_0004__screen11724161051317">{
|
|
"jobs":[
|
|
{
|
|
"id":"11bef2cb-2924-4727-a9c2-b6fec61fc03a",
|
|
"name":"SingleDbRestoreSqlserverInInstance",
|
|
"status":"Complete",
|
|
"created":"2020-07-21T01:38:00+0000",
|
|
"ended":"2020-07-21T01:39:59+0000",
|
|
"process":"",
|
|
"instance":{
|
|
"id":"9a09052dfa824caea36f583bc3e5684ein04",
|
|
"name":"rds-8d43-0004"
|
|
}
|
|
}
|
|
],
|
|
"count":1
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="rds_13_0004__p10822143810287">Task being executed:<pre class="screen" id="rds_13_0004__screen10989514111315">{
|
|
"jobs":[
|
|
{
|
|
"id": "32291a2e-882b-4266-b7c0-89dae34d2a9d",
|
|
"name": "CreateSqlserverSingleHAInstance",
|
|
"status": "Running",
|
|
"created": "2020-07-14T15:02:29+0000",
|
|
"ended": "2020-07-14T15:16:18+0000",
|
|
"process": "50",
|
|
"instance": {
|
|
"id": "9a09052dfa824caea36f583bc3e5684ein04",
|
|
"name": "rds-8d43-0004"
|
|
}
|
|
}
|
|
],
|
|
"count":1
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="rds_13_0004__p1582216383285">Task fails to be executed:<pre class="screen" id="rds_13_0004__screen715192111316">{
|
|
"jobs":[
|
|
{
|
|
"id": "32291a2e-882b-4266-b7c0-89dae34d2a9d",
|
|
"name": "CreateSqlserverSingleHAInstance",
|
|
"status": "Failed",
|
|
"created": "2020-07-14T15:02:29+0000",
|
|
"ended": "2020-07-14T15:16:18+0000",
|
|
"process": "",
|
|
"instance": {
|
|
"id": "9a09052dfa824caea36f583bc3e5684ein04",
|
|
"name": "rds-8d43-0004"
|
|
},
|
|
"fail_reason": "createVM failed."
|
|
}
|
|
],
|
|
"count":1
|
|
}</pre>
|
|
</div>
|
|
</li><li id="rds_13_0004__li1327139149">Abnormal Response<p id="rds_13_0004__p37177336172618"><a name="rds_13_0004__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_0004__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_13_0004__en-us_topic_0032347778_ul7858132212142"><li id="rds_13_0004__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_13_0004__en-us_topic_0032347778_p1040982941020"><a name="rds_13_0004__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_13_0004__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_13_0004__en-us_topic_0032347778_p0723374409"><a name="rds_13_0004__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_0004__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_13_0004__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>
|
|
|