forked from docs/doc-exports
Chen, Junjie
5e34f6ce26
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
241 lines
16 KiB
HTML
241 lines
16 KiB
HTML
<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__section7655111175616"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312016__p138241915175611">This API is used to query the number of instances in different states.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312016__section1484710512711"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312016__p152061653372">GET /v1.0/{project_id}/instances/status?includeFailure={includeFailure}</p>
|
|
<div class="p" id="dcs-api-0312016__p1666533333710"><a href="#dcs-api-0312016__table1624017336377">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312016__table1624017336377"></a><a name="table1624017336377"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312016__table1624017336377" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312016__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__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__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__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__p42409332372">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312016__row2240173333711"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312016__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__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__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__p142405335374">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row155545432517"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312016__p1738651462512">includeFailure</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__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__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__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__ul199610411577"><li id="dcs-api-0312016__li1996184155711"><strong id="dcs-api-0312016__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__li9967412576"><strong id="dcs-api-0312016__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__section188151421381"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312016__p3404124042516"><strong id="dcs-api-0312016__b12151501746">Request parameters</strong></p>
|
|
<p id="dcs-api-0312016__p17835141818277">None</p>
|
|
<p id="dcs-api-0312016__p1440412403255"><strong id="dcs-api-0312016__b18165537416">Example request</strong></p>
|
|
<pre class="screen" id="dcs-api-0312016__screen168081137423">GET https://{dcs_endpoint}/v1.0/{project_id}/instances/status?includeFailure=true</pre>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312016__section981263812810"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312016__p198704432307"><strong id="dcs-api-0312016__b1654312582419">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312016__p10162113813718"><a href="#dcs-api-0312016__table595111370375">Table 2</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312016__table595111370375"></a><a name="table595111370375"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312016__table595111370375" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312016__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__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__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__p39491937183715">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312016__row1373142317719"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p147410234712">Number of instances that are being created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row143510389719"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p17361338972">Number of instances that are being deleted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row236338974"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p173713381072">Number of running instances.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row0377387714"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p183714388719">Number of abnormal instances.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row339993617817"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p139914362812">Number of instances that are being restarted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row53991036484"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p114001136482">Number of instances that fail to be created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row815993161513"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p1016083171513">Number of instances that are being scaled up.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row21823111729"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p151821211429">Number of instances that are being upgraded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row9816121362813"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p581751362818">Number of instances for which payment is in progress.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row316151872811"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p5162131810285">Number of instances on which data migration is in progress.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row1131312115299"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p03138114298">Number of instances whose data is being cleared.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row19835175182919"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p1983555152919">Number of instances that have been stopped.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row1578513872914"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p978610387293">Number of instances that are being started.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row12720114193012"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p1972011142303">Number of instances that are being stopped.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312016__row17676932153011"><td class="cellrowborder" valign="top" width="33.333333333333336%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312016__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__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__p5934385187">Number of instances for which data restoration is in progress.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p class="msonormal" id="dcs-api-0312016__p124123494308"><strong id="dcs-api-0312016__b181548714515">Example response</strong></p>
|
|
<p id="dcs-api-0312016__p115743357234"></p>
|
|
<div class="p" id="dcs-api-0312016__p6257721142316"><pre class="screen" id="dcs-api-0312016__screen1652911344232">{"memcached":{
|
|
"paying_count":0,
|
|
"migrating_count":0,
|
|
"error_count":0,
|
|
"restarting_count":0,
|
|
"createfailed_count":0,
|
|
"flushing_count":0,
|
|
"closed_count":0,
|
|
"extending_count":0,
|
|
"creating_count":0,
|
|
"starting_count":0,
|
|
"closing_count":0,
|
|
"running_count":0,
|
|
"upgrading_count":0,
|
|
"restoring_count":0
|
|
},
|
|
"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__section865917510135"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312016__p7659155191318"><a href="#dcs-api-0312016__table36591653133">Table 3</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__table36591653133"></a><a name="table36591653133"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312016__table36591653133" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312016__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__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__p1066017520139">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312016__row1066045101315"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312016__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__p1466005171319">Quantities of DCS instances in different statuses queried successfully.</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>
|
|
|