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>
307 lines
30 KiB
HTML
307 lines
30 KiB
HTML
<a name="rds_13_0002"></a><a name="rds_13_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying Instant Tasks</h1>
|
|
<div id="body0000002507111201"><div class="section" id="rds_13_0002__section6603527917262"><h4 class="sectiontitle">Function</h4><p id="rds_13_0002__en-us_topic_0000002351955157_p16538328105512">This API is used to query instant tasks.</p>
|
|
<ul id="rds_13_0002__ul12259155218373"><li id="rds_13_0002__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_0002__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_0002__section47568069103438"><h4 class="sectiontitle">URI</h4><ul id="rds_13_0002__ul16391217184115"><li id="rds_13_0002__li363951734111">URI format<p id="rds_13_0002__p1363971724110"><a name="rds_13_0002__li363951734111"></a><a name="li363951734111"></a>GET https://{<em id="rds_13_0002__en-us_topic_0000002351955157_i2475051121512">Endpoint</em>}/v3/{<em id="rds_13_0002__en-us_topic_0000002351955157_i148911057155316">project_id</em>}/tasklist?offset={offset}&limit={limit}&id={id}&instance_id={instance_id}&order_id={order_id}&name={name}&status={status}&start_time={start_time}&end_time={end_time}</p>
|
|
</li></ul>
|
|
<ul id="rds_13_0002__ul27808384103438"><li id="rds_13_0002__li48916315103438">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0002__table37593651103438" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_13_0002__row58913670103438"><th align="left" class="cellrowborder" valign="top" width="21.69%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="rds_13_0002__p7277976103438"><strong id="rds_13_0002__b755175182210">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.31%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="rds_13_0002__p52645207103438"><strong id="rds_13_0002__b75614522215">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.36%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="rds_13_0002__p15470181141818"><strong id="rds_13_0002__b2046174934105236">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.64%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="rds_13_0002__p36403370103438"><strong id="rds_13_0002__b1056115192216">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0002__row62991866103438"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p185162372410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__p43776822">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_13_0002__p186761044260">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_0002__row64285464517"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p2592194252">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p13592842056">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1259216414514">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__p184691344165912">Specifies the index position. If <strong id="rds_13_0002__b70205942519474">offset</strong> is set to <em id="rds_13_0002__i84235269720751">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="rds_13_0002__b84235270620630">0</strong> by default, indicating that the query starts from the first piece of data. The value must be a positive number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row19660155611714"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1592541515">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p0592241950">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p45924415510">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__p887753819311">Specifies the number of records to be queried. The default value is <strong id="rds_13_0002__b163351397317">10</strong>. The value cannot be a negative number. The minimum value is <strong id="rds_13_0002__b1233533912315">1</strong> and the maximum value is <strong id="rds_13_0002__b19335123913316">50</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row0314143617546"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351955157_p465019210388">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351955157_p365082153811">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351955157_p1650122153814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__p1131413615547">Task ID, which can be used for filtering.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row69421656131718"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1397203172212">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p297219317228">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p497223192213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__p653311771811">Instance ID, which can be used for filtering.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row492981455518"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351955157_p3600992393">order_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351955157_p106001692395">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351955157_p1760089123912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__p17929131412553">Order ID, which can be used for filtering.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row1619815720175"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p25921241152">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p155923416519">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1759216419518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__p953391751817">Task name, which can be used for filtering.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row1494125817173"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p39126494228">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p18912104982211">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1091216498226">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__p45312017171815">Task status, which can be used for filtering.</p>
|
|
<ul id="rds_13_0002__en-us_topic_0000002351955157_ul113509420236"><li id="rds_13_0002__en-us_topic_0000002351955157_li166651334114016"><strong id="rds_13_0002__b10798154443814">Running</strong>: The task is running.</li><li id="rds_13_0002__en-us_topic_0000002351955157_li18368193704012"><strong id="rds_13_0002__b1161742964112349">Completed</strong>: The task is complete.</li><li id="rds_13_0002__en-us_topic_0000002351955157_li23511642192317"><strong id="rds_13_0002__b6531028311245">Failed</strong>: The task failed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row2094235861716"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p11931191112412">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1393116115247">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1893115112244">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__p1853191719188">Task start time, which can be used for filtering.</p>
|
|
<p id="rds_13_0002__p33583582298">Start time in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row1447775912177"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p19583161682415">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.31%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p10583111615249">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p4583916172412">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.64%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="rds_13_0002__en-us_topic_0000002351914973_p12311152618245">Task end time, which can be used for filtering.</p>
|
|
<p id="rds_13_0002__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_0002__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_13_0002__ul1183180183717"><li id="rds_13_0002__li1283110163719">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0002__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_13_0002__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="rds_13_0002__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="rds_13_0002__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="rds_13_0002__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="rds_13_0002__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0002__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_13_0002__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="rds_13_0002__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="rds_13_0002__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="rds_13_0002__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_13_0002__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_0002__ul1082714265612"><li id="rds_13_0002__li4411135064210">Example<pre class="screen" id="rds_13_0002__en-us_topic_0000002351955157_screen1978274981118">GET https://rds.eu-de.otc.t-systems.com/v3/54623db08b174c858ba779d2aa7923a3/tasklist?offset=1&limit=3&start_time=1747919701390&end_time=1748524501390</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_13_0002__section4828447917262"><h4 class="sectiontitle">Response</h4><ul id="rds_13_0002__ul1872869017262"><li id="rds_13_0002__li3434049017262">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0002__en-us_topic_0000002351955157_table11236435" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_13_0002__en-us_topic_0000002351955157_row61525259"><th align="left" class="cellrowborder" valign="top" width="26.240000000000002%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_13_0002__en-us_topic_0000002351955157_p17490046"><strong id="rds_13_0002__b2122562965104534">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.77%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_13_0002__en-us_topic_0000002351955157_p63149496"><strong id="rds_13_0002__b1095624518104039">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.99%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_13_0002__en-us_topic_0000002351955157_p14835533"><strong id="rds_13_0002__b1063004546105237">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0002__en-us_topic_0000002351955157_row60827539"><td class="cellrowborder" valign="top" width="26.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351955157_p963613714518">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351955157_p15636193711515">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.99%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351955157_p163615372059">Total number of tasks.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351955157_row5531104434117"><td class="cellrowborder" valign="top" width="26.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351955157_p68623417425">actions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351955157_p1086217424214">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.99%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351955157_p77232810427">List of task names.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351955157_row575195034112"><td class="cellrowborder" valign="top" width="26.240000000000002%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351955157_p1372205010412">tasks</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.77%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351955157_p2723503414">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.99%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351955157_p117235024119">Task list. For details, see <a href="#rds_13_0002__en-us_topic_0000002351914973_table1379213118720">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_13_0002__en-us_topic_0000002351914973_table1379213118720"></a><a name="en-us_topic_0000002351914973_table1379213118720"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0002__en-us_topic_0000002351914973_table1379213118720" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Tasks field description</caption><thead align="left"><tr id="rds_13_0002__en-us_topic_0000002351914973_row178461531570"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_13_0002__en-us_topic_0000002351914973_p6846531673"><strong id="rds_13_0002__b7454490511319">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.05%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_13_0002__en-us_topic_0000002351914973_p1684613114713"><strong id="rds_13_0002__b1730904448105236">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.95%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_13_0002__en-us_topic_0000002351914973_p28465311877"><strong id="rds_13_0002__b1395882623104630">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_13_0002__en-us_topic_0000002351914973_row15846103113711"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p4846123117717">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1384618311974">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p15846113120717">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351914973_row98468312713"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p14846631975">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p184614311277">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p188461531178">Task name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351914973_row8803132611297"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p974843732916">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p137481637152920">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1076153192913">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351914973_row1860132382917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p148951947162911">instance_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p14895144742917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p27623114296">Instance name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351914973_row5846113111717"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p46987515307">instance_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p5698195203010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1584683113718">Instance status.</p>
|
|
<ul id="rds_13_0002__en-us_topic_0000002351914973_ul1844818193305"><li id="rds_13_0002__en-us_topic_0000002351914973_li54481919163014"><strong id="rds_13_0002__b1271518355334">BUILD</strong>: The instance is being created.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li174486191301"><strong id="rds_13_0002__b1550823923316">CREATE FAIL</strong>: The instance failed to be created.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li4448101923011"><strong id="rds_13_0002__b49071830143410">ACTIVE</strong>: The instance is normal.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li184481419193016"><strong id="rds_13_0002__b195305473414">FAILED</strong>: The instance is abnormal.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li1448019173013"><strong id="rds_13_0002__b121919223513">FROZEN</strong>: The instance is frozen.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li1644861913017"><strong id="rds_13_0002__b8498132712354">MODIFYING</strong>: The instance is being scaled up.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li544816199303"><strong id="rds_13_0002__b1058065512354">REBOOTING</strong>: The instance is being rebooted.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li244812191302"><strong id="rds_13_0002__b1354925615380">RESTORING</strong>: The instance is being restored.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li244881911305"><strong id="rds_13_0002__b326216314433">MODIFYING INSTANCE TYPE</strong>: The instance is being changed to primary/standby.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li244815198304"><strong id="rds_13_0002__b192894139432">SWITCHOVER</strong>: A primary/standby switchover is being performed.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li244831916302"><strong id="rds_13_0002__b3361181211444">MIGRATING</strong>: The instance is being migrated.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li19448019163017"><strong id="rds_13_0002__b143031647131411">BACKING UP</strong>: The instance is being backed up.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li1066143303013"><strong id="rds_13_0002__b18823641154">MODIFYING DATABASE PORT</strong>: The database port is being changed.</li><li id="rds_13_0002__en-us_topic_0000002351914973_li11448111915307"><strong id="rds_13_0002__b1468414258151">STORAGE FULL</strong>: The instance storage is full.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row13461611232"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351955157_p987195916455">order_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351955157_p78795918452">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__p234611335">Order ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351914973_row384717311778"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351955157_p15115159124620">process</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351955157_p61151597468">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__p18764428415">Task progress, in percentage.</p>
|
|
<p id="rds_13_0002__p197111516612">If the task is in the <strong id="rds_13_0002__b201447532213">Completed</strong> or <strong id="rds_13_0002__b89883557218">Failed</strong> status, the value is an empty string.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__row353814301932"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351955157_p1559383924513">fail_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351955157_p9593193924512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351955157_p14745731164518">Failure cause.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351914973_row22881721113120"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p2027612103110">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p927616218316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p827612215318">Task creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="rds_13_0002__en-us_topic_0000002351914973_p32768215314"><strong id="rds_13_0002__b15867191515157">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_13_0002__b3867101510156">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351914973_row192887210315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p027732123113">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p0277121133110">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p8277132193117">Planned task end time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="rds_13_0002__en-us_topic_0000002351914973_p5277142111311"><strong id="rds_13_0002__b19949194311155">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_13_0002__b19949204321517">Z</strong> indicates the time zone offset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_13_0002__en-us_topic_0000002351914973_row1288122112319"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0002__en-us_topic_0000002351914973_p1227711216319">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.05%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_13_0002__en-us_topic_0000002351914973_p18277221143119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.95%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_13_0002__en-us_topic_0000002351914973_p11277421103120">Task status.</p>
|
|
<ul id="rds_13_0002__en-us_topic_0000002351955157_ul149741813124416"><li id="rds_13_0002__en-us_topic_0000002351955157_li2097461384416"><strong id="rds_13_0002__b369541005112329">Running</strong>: The task is running.</li><li id="rds_13_0002__en-us_topic_0000002351955157_li59741313134418"><strong id="rds_13_0002__b2089001392112349">Completed</strong>: The task is complete.</li><li id="rds_13_0002__en-us_topic_0000002351955157_li119742134448"><strong id="rds_13_0002__b43864941711245">Failed</strong>: The task failed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_13_0002__ul2705380172618"><li id="rds_13_0002__li24348422172618">Example normal response<pre class="screen" id="rds_13_0002__en-us_topic_0000002351955157_screen1439165917105">{
|
|
"tasks" : [ {
|
|
"id" : "676e9f17f9b74289883a44a47b8101f5",
|
|
"name" : "RestoreSqlserverInInstance",
|
|
"instance_id" : "4d00c7e9d22145deb889937a72b59c8ein01",
|
|
"instance_name" : "rds-local-scale",
|
|
"instance_status" : "FAILED",
|
|
"order_id" : "",
|
|
"process" : "",
|
|
"create_time" : "2020-07-15T07:46:10+0000",
|
|
"end_time" : "2020-07-15T09:46:10+0000",
|
|
"status" : "Completed"
|
|
} ],
|
|
"actions" : [ "RestoreSqlserverInInstance" ],
|
|
"total_count" : 1
|
|
}</pre>
|
|
</li><li id="rds_13_0002__li1327139149">Abnormal Response<p id="rds_13_0002__p37177336172618"><a name="rds_13_0002__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_0002__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_13_0002__en-us_topic_0032347778_ul7858132212142"><li id="rds_13_0002__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_13_0002__en-us_topic_0032347778_p1040982941020"><a name="rds_13_0002__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_13_0002__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_13_0002__en-us_topic_0032347778_p0723374409"><a name="rds_13_0002__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_0002__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_13_0002__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>
|
|
|