yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
0b3a43371a4bcc99577594de0a685249d676a567
doc-exports/docs/rds/api-ref/rds_13_0001.html
wangdengke2 1ddaec1a62 rds_api 
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>
2026-01-29 11:28:26 +00:00

348 lines
35 KiB
HTML
Raw Blame History

<a name="rds_13_0001"></a><a name="rds_13_0001"></a>
<h1 class="topictitle1">Querying Scheduled Tasks</h1>
<div id="body0000002507031149"><div class="section" id="rds_13_0001__section6603527917262"><h4 class="sectiontitle">Function</h4><p id="rds_13_0001__en-us_topic_0000002351914973_p16538328105512">This API is used to query scheduled tasks.</p>
<ul id="rds_13_0001__ul12259155218373"><li id="rds_13_0001__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_0001__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_0001__section47568069103438"><h4 class="sectiontitle">URI</h4><ul id="rds_13_0001__ul16391217184115"><li id="rds_13_0001__li363951734111">URI format<p id="rds_13_0001__p1363971724110"><a name="rds_13_0001__li363951734111"></a><a name="li363951734111"></a>GET https://{<em id="rds_13_0001__i155911241191710">Endpoint</em>}/v3/{<em id="rds_13_0001__en-us_topic_0000002351914973_i148911057155316">project_id</em>}/schedule-tasks?offset={offset}&amp;limit={limit}&amp;instance_name={instance_name}&amp;instance_id={instance_id}&amp;status={status}&amp;start_time={start_time}&amp;end_time={end_time}</p>
</li></ul>
<ul id="rds_13_0001__ul27808384103438"><li id="rds_13_0001__li48916315103438">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0001__table37593651103438" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_13_0001__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_0001__p7277976103438"><strong id="rds_13_0001__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_0001__p52645207103438"><strong id="rds_13_0001__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_0001__p15470181141818"><strong id="rds_13_0001__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_0001__p36403370103438"><strong id="rds_13_0001__b1056115192216">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_13_0001__row62991866103438"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0001__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_0001__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_0001__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_0001__p43776822">Specifies the project ID of a tenant in a region.</p>
<p id="rds_13_0001__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_0001__row64285464517"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0001__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_0001__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_0001__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_0001__p184691344165912">Specifies the index position. If <strong id="rds_13_0001__b70205942519474">offset</strong> is set to <em id="rds_13_0001__i84235269720751">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="rds_13_0001__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_0001__row19660155611714"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0001__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_0001__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_0001__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_0001__p887753819311">Specifies the number of records to be queried. The default value is <strong id="rds_13_0001__b163351397317">10</strong>. The value cannot be a negative number. The minimum value is <strong id="rds_13_0001__b1233533912315">1</strong> and the maximum value is <strong id="rds_13_0001__b19335123913316">50</strong>.</p>
</td>
</tr>
<tr id="rds_13_0001__row69421656131718"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0001__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_0001__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_0001__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_0001__p653311771811">Instance ID, which can be used for filtering.</p>
</td>
</tr>
<tr id="rds_13_0001__row1619815720175"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p25921241152">instance_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_0001__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_0001__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_0001__p953391751817">Instance name, which can be used for filtering.</p>
</td>
</tr>
<tr id="rds_13_0001__row1494125817173"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0001__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_0001__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_0001__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_0001__p45312017171815">Task status, which can be used for filtering.</p>
<ul id="rds_13_0001__en-us_topic_0000002351914973_ul113509420236"><li id="rds_13_0001__en-us_topic_0000002351914973_li20350242202317"><strong id="rds_13_0001__b1922364312215">Initing</strong>: The task is being initialized.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li1735017420238"><strong id="rds_13_0001__b65811210122312">Pending</strong>: The task is pending.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li1035044215232"><strong id="rds_13_0001__b1178152652316">Running</strong>: The task is running.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li735094222318"><strong id="rds_13_0001__b19874154522315">Completed</strong>: The task is complete.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li133511242152316"><strong id="rds_13_0001__b335880132410">Failed</strong>: The task failed.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li9351124210232"><strong id="rds_13_0001__b12350121913240">Unauthorized</strong>: The task is unauthorized.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li5351124216232"><strong id="rds_13_0001__b165023295243">Canceled</strong>: The task is canceled.</li></ul>
</td>
</tr>
<tr id="rds_13_0001__row2094235861716"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0001__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_0001__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_0001__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_0001__p1853191719188">Task start time.</p>
<p id="rds_13_0001__p12926174318345">Start time in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.</p>
</td>
</tr>
<tr id="rds_13_0001__row1447775912177"><td class="cellrowborder" valign="top" width="21.69%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="rds_13_0001__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_0001__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_0001__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_0001__en-us_topic_0000002351914973_p12311152618245">Task end time.</p>
<p id="rds_13_0001__p115801952163412">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_0001__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_13_0001__ul1183180183717"><li id="rds_13_0001__li1283110163719">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0001__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_13_0001__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_0001__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_0001__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_0001__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_0001__p551110331335">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="rds_13_0001__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_13_0001__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_0001__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_0001__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_0001__p1086851153317">Specifies the user token.</p>
<p id="rds_13_0001__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_0001__ul1082714265612"><li id="rds_13_0001__li4411135064210">Example<pre class="screen" id="rds_13_0001__en-us_topic_0000002351914973_screen1978274981118">GET https://rds.eu-de.otc.t-systems.com/v3/54623db08b174c858ba779d2aa7923a3/schedule-tasks?offset=1&amp;limit=3&amp;instance_id=43e4feaab48f11e89039fa163ebaa7e4in04&amp;instance_name=sqlserver_instance&amp;start_time=1747919701390&amp;end_time=1748524501390</pre>
</li></ul>
</div>
<div class="section" id="rds_13_0001__section4828447917262"><h4 class="sectiontitle">Response</h4><ul id="rds_13_0001__ul1872869017262"><li id="rds_13_0001__li3434049017262">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0001__table54571314103317" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_13_0001__row3459121463318"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_13_0001__p91816414334"><strong id="rds_13_0001__b0591253228">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.3%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_13_0001__p123216414335"><strong id="rds_13_0001__b19591650227">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.7%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_13_0001__p440144113310"><strong id="rds_13_0001__b1593518220">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_13_0001__row16459161403314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p26264512278">schedule_tasks</p>
</td>
<td class="cellrowborder" valign="top" width="25.3%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_13_0001__en-us_topic_0000002351914973_p1513820463515">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="49.7%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_13_0001__en-us_topic_0000002351914973_p213894610516">Scheduled task list. For details, see <a href="#rds_13_0001__en-us_topic_0000002351914973_table1379213118720">Table 4</a>.</p>
</td>
</tr>
<tr id="rds_13_0001__row2367713135211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p963613714518">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="25.3%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_13_0001__en-us_topic_0000002351914973_p15636193711515">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.7%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_13_0001__en-us_topic_0000002351914973_p163615372059">Total number of tasks.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rds_13_0001__en-us_topic_0000002351914973_table1379213118720"></a><a name="en-us_topic_0000002351914973_table1379213118720"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0001__en-us_topic_0000002351914973_table1379213118720" frame="border" border="1" rules="all"><caption><b>Table 4 </b>schedule_tasks field description</caption><thead align="left"><tr id="rds_13_0001__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_0001__en-us_topic_0000002351914973_p6846531673"><strong id="rds_13_0001__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_0001__en-us_topic_0000002351914973_p1684613114713"><strong id="rds_13_0001__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_0001__en-us_topic_0000002351914973_p28465311877"><strong id="rds_13_0001__b1395882623104630">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_13_0001__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_0001__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_0001__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_0001__en-us_topic_0000002351914973_p15846113120717">Task ID.</p>
</td>
</tr>
<tr id="rds_13_0001__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_0001__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_0001__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_0001__en-us_topic_0000002351914973_p188461531178">Task name.</p>
</td>
</tr>
<tr id="rds_13_0001__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_0001__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_0001__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_0001__en-us_topic_0000002351914973_p1076153192913">Instance ID.</p>
</td>
</tr>
<tr id="rds_13_0001__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_0001__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_0001__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_0001__en-us_topic_0000002351914973_p27623114296">Instance name.</p>
</td>
</tr>
<tr id="rds_13_0001__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_0001__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_0001__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_0001__en-us_topic_0000002351914973_p1584683113718">Instance status.</p>
<ul id="rds_13_0001__en-us_topic_0000002351914973_ul1844818193305"><li id="rds_13_0001__en-us_topic_0000002351914973_li54481919163014"><strong id="rds_13_0001__b1271518355334">BUILD</strong>: The instance is being created.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li174486191301"><strong id="rds_13_0001__b1550823923316">CREATE FAIL</strong>: The instance failed to be created.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li4448101923011"><strong id="rds_13_0001__b49071830143410">ACTIVE</strong>: The instance is normal.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li184481419193016"><strong id="rds_13_0001__b195305473414">FAILED</strong>: The instance is abnormal.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li1448019173013"><strong id="rds_13_0001__b121919223513">FROZEN</strong>: The instance is frozen.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li1644861913017"><strong id="rds_13_0001__b8498132712354">MODIFYING</strong>: The instance is being scaled up.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li544816199303"><strong id="rds_13_0001__b1058065512354">REBOOTING</strong>: The instance is being rebooted.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li244812191302"><strong id="rds_13_0001__b1354925615380">RESTORING</strong>: The instance is being restored.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li244881911305"><strong id="rds_13_0001__b326216314433">MODIFYING INSTANCE TYPE</strong>: The instance is being changed to primary/standby.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li244815198304"><strong id="rds_13_0001__b192894139432">SWITCHOVER</strong>: A primary/standby switchover is being performed.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li244831916302"><strong id="rds_13_0001__b3361181211444">MIGRATING</strong>: The instance is being migrated.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li19448019163017"><strong id="rds_13_0001__b143031647131411">BACKING UP</strong>: The instance is being backed up.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li1066143303013"><strong id="rds_13_0001__b18823641154">MODIFYING DATABASE PORT</strong>: The database port is being changed.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li11448111915307"><strong id="rds_13_0001__b1468414258151">STORAGE FULL</strong>: The instance storage is full.</li></ul>
</td>
</tr>
<tr id="rds_13_0001__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_0001__en-us_topic_0000002351914973_p8101125153013">project_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_0001__en-us_topic_0000002351914973_p161011518306">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_0001__en-us_topic_0000002351914973_p168479319719">Project ID.</p>
</td>
</tr>
<tr id="rds_13_0001__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_0001__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_0001__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_0001__en-us_topic_0000002351914973_p827612215318">Task creation time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="rds_13_0001__en-us_topic_0000002351914973_p32768215314"><strong id="rds_13_0001__b15867191515157">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_13_0001__b3867101510156">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="rds_13_0001__en-us_topic_0000002351914973_row9288621163113"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p1627610211316">start_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_0001__en-us_topic_0000002351914973_p727622173113">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_0001__en-us_topic_0000002351914973_p1027692173116">Planned task start time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="rds_13_0001__en-us_topic_0000002351914973_p142764218311"><strong id="rds_13_0001__b36918267154">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_13_0001__b166911326191519">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="rds_13_0001__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_0001__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_0001__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_0001__en-us_topic_0000002351914973_p8277132193117">Planned task end time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="rds_13_0001__en-us_topic_0000002351914973_p5277142111311"><strong id="rds_13_0001__b19949194311155">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_13_0001__b19949204321517">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="rds_13_0001__en-us_topic_0000002351914973_row228802117313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p20277132118315">order</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_0001__en-us_topic_0000002351914973_p142771121153117">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_0001__en-us_topic_0000002351914973_p148891126123215">Task priority.</p>
<p id="rds_13_0001__en-us_topic_0000002351914973_p727732183117">An integer ranging from 1 to 100. A smaller value indicates a higher priority.</p>
</td>
</tr>
<tr id="rds_13_0001__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_0001__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_0001__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_0001__en-us_topic_0000002351914973_p11277421103120">Task status.</p>
<ul id="rds_13_0001__en-us_topic_0000002351914973_ul715142314334"><li id="rds_13_0001__en-us_topic_0000002351914973_li715172319333"><strong id="rds_13_0001__b815518018233">Initing</strong>: The task is being initialized.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li7161123143313"><strong id="rds_13_0001__b8572316152312">Pending</strong>: The task is pending.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li21632383310"><strong id="rds_13_0001__b73716295232">Running</strong>: The task is running.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li1716192317332"><strong id="rds_13_0001__b2081944842310">Completed</strong>: The task is complete.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li161692316333"><strong id="rds_13_0001__b156801347240">Failed</strong>: The task failed.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li151615236334"><strong id="rds_13_0001__b933142112415">Unauthorized</strong>: The task is unauthorized.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li181642333318"><strong id="rds_13_0001__b64151931152411">Canceled</strong>: The task is canceled.</li><li id="rds_13_0001__en-us_topic_0000002351914973_li1616152323320"><strong id="rds_13_0001__b3819165215226">Deleted</strong>: The task is deleted.</li></ul>
</td>
</tr>
<tr id="rds_13_0001__en-us_topic_0000002351914973_row128812215315"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p1927752133116">datastore_type</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_0001__en-us_topic_0000002351914973_p15277112163119">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_0001__en-us_topic_0000002351914973_p62771421183119">Database type.</p>
</td>
</tr>
<tr id="rds_13_0001__en-us_topic_0000002351914973_row12288122123111"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p202771210316">volume_type</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_0001__en-us_topic_0000002351914973_p327712218316">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_0001__en-us_topic_0000002351914973_p202781221143115">Storage type.</p>
</td>
</tr>
<tr id="rds_13_0001__en-us_topic_0000002351914973_row1728713218311"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p22787217314">target_config</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_0001__en-us_topic_0000002351914973_p14278122113315">object</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_0001__en-us_topic_0000002351914973_p132781212316">Target configuration. For details, see <a href="#rds_13_0001__en-us_topic_0000002351914973_table18585181819340">Table 5</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rds_13_0001__en-us_topic_0000002351914973_table18585181819340"></a><a name="en-us_topic_0000002351914973_table18585181819340"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_13_0001__en-us_topic_0000002351914973_table18585181819340" frame="border" border="1" rules="all"><caption><b>Table 5 </b>target_config</caption><thead align="left"><tr id="rds_13_0001__en-us_topic_0000002351914973_row8613618113418"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="rds_13_0001__en-us_topic_0000002351914973_p12613918133418"><strong id="rds_13_0001__b107715406211319">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="rds_13_0001__en-us_topic_0000002351914973_p7613718123415"><strong id="rds_13_0001__b1262477896105236">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="rds_13_0001__en-us_topic_0000002351914973_p96135188344"><strong id="rds_13_0001__b648543292104630">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_13_0001__en-us_topic_0000002351914973_row3613718113415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p10613191813345">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_13_0001__en-us_topic_0000002351914973_p66139188345">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_13_0001__en-us_topic_0000002351914973_p955575716348">Instance class.</p>
<p id="rds_13_0001__en-us_topic_0000002351914973_p1261316189348">If <strong id="rds_13_0001__b2200595247">name</strong> is set to <strong id="rds_13_0001__b016941013256">RESIZE_FLAVOR</strong>, this parameter indicates the target instance class.</p>
</td>
</tr>
<tr id="rds_13_0001__en-us_topic_0000002351914973_row26138189343"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p5613131813418">cpu</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_13_0001__en-us_topic_0000002351914973_p10613111817343">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_13_0001__en-us_topic_0000002351914973_p1173311212365">Instance vCPUs.</p>
<p id="rds_13_0001__en-us_topic_0000002351914973_p13613101833418">If <strong id="rds_13_0001__b10814392269">name</strong> is set to <strong id="rds_13_0001__b1481039192618">RESIZE_FLAVOR</strong>, this parameter indicates the target vCPUs.</p>
</td>
</tr>
<tr id="rds_13_0001__en-us_topic_0000002351914973_row9613201816349"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_13_0001__en-us_topic_0000002351914973_p20613618113419">mem</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_13_0001__en-us_topic_0000002351914973_p46131918153411">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_13_0001__en-us_topic_0000002351914973_p4392459364">Instance memory.</p>
<p id="rds_13_0001__en-us_topic_0000002351914973_p461318183341">If <strong id="rds_13_0001__b82501159142611">name</strong> is set to <strong id="rds_13_0001__b19250145942617">RESIZE_FLAVOR</strong>, this parameter indicates the target memory.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="rds_13_0001__ul2705380172618"><li id="rds_13_0001__li24348422172618">Example normal response<pre class="screen" id="rds_13_0001__en-us_topic_0000002351914973_screen1439165917105">{
"schedule_tasks" : [
{
"id" : "5ed6a9e95f2747f7bac1b5899ddd1316",
"instance_id" : "3d2929b2c7ea4fe9bd27f21061d037ccin01",
"instance_name" : "rds-zfs-test-56-44",
"instance_status" : "ACTIVE",
"project_id" : "54623db08b174c858ba779d2aa7923a3",
"name" : "RESIZE_FLAVOR",
"create_time" : "2020-07-15T07:46:10+0000",
"start_time" : "2020-07-15T08:46:10+0000",
"end_time" : "2020-07-15T09:46:10+0000",
"order" : "1",
"status" : "Canceled",
"datastore_type" : "mysql",
"target_config" : {
"flavor" : "rds.mysql.n1.xlarge.2",
"mem" : "8",
"cpu" : "4"
},
"volume_type" : "CLOUDSSD"
} ],
"total_count" : 1
}</pre>
</li><li id="rds_13_0001__li1327139149">Abnormal Response<p id="rds_13_0001__p37177336172618"><a name="rds_13_0001__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_0001__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_13_0001__en-us_topic_0032347778_ul7858132212142"><li id="rds_13_0001__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_13_0001__en-us_topic_0032347778_p1040982941020"><a name="rds_13_0001__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
</li><li id="rds_13_0001__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_13_0001__en-us_topic_0032347778_p0723374409"><a name="rds_13_0001__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_0001__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_13_0001__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>
View Git Blame Copy Permalink