vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dcs/api-ref/dcs-api-0312016.html
Chen, Junjie a03981f7be DCS API 20230220 Version 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2024-04-22 14:08:39 +00:00

406 lines
34 KiB
HTML
Raw Permalink Blame History

<a name="dcs-api-0312016"></a><a name="dcs-api-0312016"></a>
<h1 class="topictitle1">Querying DCS Instance Status</h1>
<div id="body62718682"><div class="section" id="dcs-api-0312016__en-us_topic_0166889648_section7655111175616"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312016__en-us_topic_0166889648_p138241915175611">This API is used to query the number of instances in different states.</p>
</div>
<div class="section" id="dcs-api-0312016__en-us_topic_0166889648_section1484710512711"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312016__en-us_topic_0166889648_p152061653372">GET /v1.0/{project_id}/instances/status?include_failure={include_failure}</p>
<div class="p" id="dcs-api-0312016__en-us_topic_0166889648_p1666533333710"><a href="#dcs-api-0312016__en-us_topic_0166889648_table1624017336377">Table 1</a> describes the parameters.
<div class="tablenoborder"><a name="dcs-api-0312016__en-us_topic_0166889648_table1624017336377"></a><a name="en-us_topic_0166889648_table1624017336377"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312016__en-us_topic_0166889648_table1624017336377" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312016__en-us_topic_0166889648_row172405338371"><th align="left" class="cellrowborder" valign="top" width="25.252525252525253%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312016__en-us_topic_0166889648_p323919337375">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312016__en-us_topic_0166889648_p1524013335373">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312016__en-us_topic_0166889648_p1324010337372">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="37.37373737373738%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312016__en-us_topic_0166889648_p42409332372">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312016__en-us_topic_0166889648_row2240173333711"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p13240183343720">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p13240123314374">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1224073317379">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="37.37373737373738%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312016__en-us_topic_0166889648_p142405335374">Project ID. For details on how to obtain the value of this parameter, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row155545432517"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1738651462512">include_failure</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p93879142256">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p93871814152515">No</p>
</td>
<td class="cellrowborder" valign="top" width="37.37373737373738%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1472542022512">An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller. Options:</p>
<ul id="dcs-api-0312016__en-us_topic_0166889648_ul199610411577"><li id="dcs-api-0312016__en-us_topic_0166889648_li1996184155711"><strong id="dcs-api-0312016__en-us_topic_0166889648_b17321172843320">true</strong>: The number of DCS instances that failed to be created will be returned to the API caller.</li><li id="dcs-api-0312016__en-us_topic_0166889648_li9967412576"><strong id="dcs-api-0312016__en-us_topic_0166889648_b7549183163619">false</strong> or others: The number of DCS instances that failed to be created will not be returned to the API caller.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="dcs-api-0312016__en-us_topic_0166889648_section188151421381"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312016__en-us_topic_0166889648_p3404124042516"><strong id="dcs-api-0312016__en-us_topic_0166889648_b12151501746">Request parameters</strong></p>
<p id="dcs-api-0312016__en-us_topic_0166889648_p17835141818277">None</p>
<p id="dcs-api-0312016__en-us_topic_0166889648_p1440412403255"><strong id="dcs-api-0312016__en-us_topic_0166889648_b18165537416">Example request</strong></p>
<pre class="screen" id="dcs-api-0312016__en-us_topic_0166889648_screen168081137423">GET https://{dcs_endpoint}/v1.0/{project_id}/instances/status?include_failure=true</pre>
</div>
<div class="section" id="dcs-api-0312016__en-us_topic_0166889648_section981263812810"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312016__en-us_topic_0166889648_p198704432307"><strong id="dcs-api-0312016__en-us_topic_0166889648_b1654312582419">Response parameters</strong></p>
<div class="msonormal" id="dcs-api-0312016__en-us_topic_0166889648_p10162113813718"><a href="#dcs-api-0312016__en-us_topic_0166889648_table595111370375">Table 2</a> describes the response parameters.
<div class="tablenoborder"><a name="dcs-api-0312016__en-us_topic_0166889648_table595111370375"></a><a name="en-us_topic_0166889648_table595111370375"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312016__en-us_topic_0166889648_table595111370375" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312016__en-us_topic_0166889648_row794915372377"><th align="left" class="cellrowborder" valign="top" width="33.333333333333336%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312016__en-us_topic_0166889648_p20949037193710">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.21212121212121%" id="mcps1.3.4.3.2.2.4.1.2"><p id="dcs-api-0312016__en-us_topic_0166889648_p13949153763712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.45454545454546%" id="mcps1.3.4.3.2.2.4.1.3"><p id="dcs-api-0312016__en-us_topic_0166889648_p39491937183715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312016__en-us_topic_0166889648_row181097504"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p481795501">redis</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p16482135319500"><a href="#dcs-api-0312016__en-us_topic_0166889648_response_StatusStatistic">StatusStatistic</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p748245312500">Redis instance quantity statistics.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row1373142317719"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1673122311718">creating_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1731923974">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p147410234712">Number of instances that are being created.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row143510389719"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p3363381170">deleting_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p12361538673">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p17361338972">Number of instances that are being deleted.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row236338974"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p4371338972">running_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p537163817718">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p173713381072">Number of running instances.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row0377387714"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p537238473">error_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p18372383710">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p183714388719">Number of abnormal instances.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row339993617817"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1439943616811">restarting_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p173997361883">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p139914362812">Number of instances that are being restarted.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row53991036484"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1039953618810">createfailed_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p12399836185">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p114001136482">Number of instances that fail to be created.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row815993161513"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p016023161518">extending_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p516043151515">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1016083171513">Number of instances that are being scaled up.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row21823111729"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p6182811726">upgrading_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1318214111826">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p151821211429">Number of instances that are being upgraded.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row9816121362813"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1681619136284">paying_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p149521618145811">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p581751362818">Number of instances for which payment is in progress.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row316151872811"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p11624188283">migrating_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p433310218584">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p5162131810285">Number of instances on which data migration is in progress.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row1131312115299"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p203136112917">flushing_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1085042212587">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p03138114298">Number of instances whose data is being cleared.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row19835175182919"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p188359511295">closed_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1027492414581">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1983555152919">Number of instances that have been stopped.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row1578513872914"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p117861238152920">starting_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p18849182517583">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p978610387293">Number of instances that are being started.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row12720114193012"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p10720121420309">closing_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p125151429125820">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1972011142303">Number of instances that are being stopped.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row17676932153011"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p17676153243017">restoring_count</p>
</td>
<td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p12947193017583">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p5934385187">Number of instances for which data restoration is in progress.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="dcs-api-0312016__en-us_topic_0166889648_response_StatusStatistic"></a><a name="en-us_topic_0166889648_response_StatusStatistic"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312016__en-us_topic_0166889648_response_StatusStatistic" frame="border" border="1" rules="all"><caption><b>Table 3 </b>StatusStatistic</caption><thead align="left"><tr id="dcs-api-0312016__en-us_topic_0166889648_row7513135317508"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312016__en-us_topic_0166889648_p251514536500">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312016__en-us_topic_0166889648_p1451613530502">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312016__en-us_topic_0166889648_p19517175375016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312016__en-us_topic_0166889648_row165131653185011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p145178537506">paying_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p2518165315017">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p15519115375016">Number of instances for which payment is in progress.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row12513175325015"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1152355317507">migrating_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p95235536509">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p4524175375015">Number of instances on which data migration is in progress.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row185149536507"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p2525145335016">flushing_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p752517537509">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p752695315505">Number of instances whose data is being cleared.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row145141953105017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p352717531505">upgrading_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1152813538501">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p652811536500">Number of instances that are being upgraded.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row1151495385019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1652955355010">restoring_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1753018539501">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1053085311509">Number of instances for which data restoration is in progress.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row65141853185017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p205311853115013">extending_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p19532553145015">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p953335313507">Number of instances that are being scaled up.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row135142533501"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p453318530505">creating_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p175347531505">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p165353536501">Number of instances that are being created.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row13514145315010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p16535145320503">running_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p4536145315010">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p753785315019">Number of running instances.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row17514145375018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p85421553135017">error_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p7543105325020">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p354385365014">Number of abnormal instances.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row1051418536509"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p2546453205019">createfailed_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p4547153165014">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1854820535508">Number of instances that fail to be created.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row0514185385012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p95481453115017">restarting_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p165490536508">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p95501953165014">Number of instances that are being restarted.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="dcs-api-0312016__en-us_topic_0166889648_p0550185365017"><strong id="dcs-api-0312016__en-us_topic_0166889648_b133205446337">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312016__en-us_topic_0166889648_response_ErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="dcs-api-0312016__en-us_topic_0166889648_row1551135365016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="dcs-api-0312016__en-us_topic_0166889648_p7553135395018">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="dcs-api-0312016__en-us_topic_0166889648_p655405365017">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="dcs-api-0312016__en-us_topic_0166889648_p1355517533506">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312016__en-us_topic_0166889648_row6551753195013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p20556115313506">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p75561053145016">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1355785311504">Error message.</p>
<p id="dcs-api-0312016__en-us_topic_0166889648_p9558205315018">Maximum length: 1024 characters</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row1055116534509"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p125591253145018">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p15559185365011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p356025345018">Error code.</p>
<p id="dcs-api-0312016__en-us_topic_0166889648_p1556116530507">Maximum length: 9 characters</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row155185319508"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1156275319503">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p2562115315011">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1556312536507">Extended error information. This parameter is not used currently and is set to null.</p>
<p id="dcs-api-0312016__en-us_topic_0166889648_p1564165355017">Maximum length: 1024 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="dcs-api-0312016__en-us_topic_0166889648_p105651653115013"><strong id="dcs-api-0312016__en-us_topic_0166889648_b142521411344">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312016__en-us_topic_0166889648_table35651553125014" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="dcs-api-0312016__en-us_topic_0166889648_row1056575375011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="dcs-api-0312016__en-us_topic_0166889648_p2567165395019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="dcs-api-0312016__en-us_topic_0166889648_p356855315010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="dcs-api-0312016__en-us_topic_0166889648_p95691253185015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312016__en-us_topic_0166889648_row135661253195017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p165701553135020">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p857013530504">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p175711453155013">Error message.</p>
<p id="dcs-api-0312016__en-us_topic_0166889648_p257265315017">Maximum length: 1024 characters</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row17566953185013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p165730532502">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p35731953195016">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p4574135318506">Error code.</p>
<p id="dcs-api-0312016__en-us_topic_0166889648_p12575105315509">Maximum length: 9 characters</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row1566953165020"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p19576115310501">error_ext_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1857675345010">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1957711536501">Extended error information. This parameter is not used currently and is set to null.</p>
<p id="dcs-api-0312016__en-us_topic_0166889648_p105781453145016">Maximum length: 1024 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
<p class="msonormal" id="dcs-api-0312016__en-us_topic_0166889648_p124123494308"><strong id="dcs-api-0312016__en-us_topic_0166889648_b181548714515">Example response</strong></p>
<p id="dcs-api-0312016__en-us_topic_0166889648_p115743357234"></p>
<div class="p" id="dcs-api-0312016__en-us_topic_0166889648_p6257721142316"><pre class="screen" id="dcs-api-0312016__en-us_topic_0166889648_screen1652911344232">{
"paying_count":0,
"migrating_count":0,
"error_count":0,
"restarting_count":0,
"createfailed_count":0,
"flushing_count":0,
"redis":{
"paying_count":0,
"migrating_count":0,
"error_count":0,
"restarting_count":0,
"createfailed_count":0,
"flushing_count":0,
"closed_count":0,
"extending_count":2,
"creating_count":0,
"starting_count":0,
"closing_count":0,
"running_count":1,
"upgrading_count":0,
"restoring_count":0
},
"closed_count":0,
"extending_count":2,
"creating_count":0,
"starting_count":0,
"closing_count":0,
"running_count":1,
"upgrading_count":0,
"restoring_count":0}
}</pre>
</div>
</div>
<div class="section" id="dcs-api-0312016__en-us_topic_0166889648_section865917510135"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312016__en-us_topic_0166889648_p7659155191318"><a href="#dcs-api-0312016__en-us_topic_0166889648_table36591653133">Table 6</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
<div class="tablenoborder"><a name="dcs-api-0312016__en-us_topic_0166889648_table36591653133"></a><a name="en-us_topic_0166889648_table36591653133"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312016__en-us_topic_0166889648_table36591653133" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312016__en-us_topic_0166889648_row766085191316"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312016__en-us_topic_0166889648_p1666016571317">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312016__en-us_topic_0166889648_p1066017520139">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312016__en-us_topic_0166889648_row1066045101315"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1666011541314">200</p>
</td>
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p1466005171319">Quantities of DCS instances in different statuses queried successfully.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row1524118591817"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p201891954115012">400</p>
</td>
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p17189125465010">The request is invalid.</p>
</td>
</tr>
<tr id="dcs-api-0312016__en-us_topic_0166889648_row15271115517817"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312016__en-us_topic_0166889648_p12189125415018">500</p>
</td>
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312016__en-us_topic_0166889648_p19190254165017">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312035.html">Instance Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink