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>
116 lines
8.6 KiB
HTML
116 lines
8.6 KiB
HTML
<a name="dcs-api-0312010"></a><a name="dcs-api-0312010"></a>
|
|
|
|
<h1 class="topictitle1">Scaling Up a DCS Instance</h1>
|
|
<div id="body1494301127299"><div class="section" id="dcs-api-0312010__section1119991614542"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312010__p20191940121113">This API is used to scale up a DCS <span id="dcs-api-0312010__text1561431311121">Redis</span> instance in the <strong id="dcs-api-0312010__b490412114319">Running</strong> state.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312010__section2310177194512"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312010__p1552254314416">POST /v1.0/{project_id}/instances/{instance_id}/extend</p>
|
|
<div class="p" id="dcs-api-0312010__p13578121810355"><a href="#dcs-api-0312010__table4154121820350">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312010__table4154121820350"></a><a name="table4154121820350"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312010__table4154121820350" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312010__row17153191817358"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312010__p993885712414">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312010__p215314189354">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312010__p1715320185352">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312010__p215351873519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312010__row61531718163510"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312010__p51531218183514">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312010__p115311813514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312010__p815391853510">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312010__p1153818143518">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312010__row1358873516587"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312010__p1137117202451">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312010__p193715205458">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312010__p637142014512">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312010__p53711207459">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312010__section41195764519"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312010__p269951018401"><strong id="dcs-api-0312010__b1082510012452">Request parameters</strong></p>
|
|
<div class="p" id="dcs-api-0312010__p969918109405"><a href="#dcs-api-0312010__table166993107405">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312010__table166993107405"></a><a name="table166993107405"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312010__table166993107405" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312010__row7700310174015"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.2.5.1.1"><p id="dcs-api-0312010__p770012105401">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.2.5.1.2"><p id="dcs-api-0312010__p5700201018409">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.3.2.2.5.1.3"><p id="dcs-api-0312010__p0700210154019">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.3.3.2.2.5.1.4"><p id="dcs-api-0312010__p9700610174018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312010__row13700121010407"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312010__p38321751124510">new_capacity</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312010__p198321551134517">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.2.5.1.3 "><p id="dcs-api-0312010__p38321751104511">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312010__p08324511459">New specification (memory space) of the DCS instance. The new specification to which the DCS instance will be scaled up must be greater than the current specification. Unit: GB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312010__row1452012418326"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312010__p12631132714611">spec_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312010__p132391951151516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.3.2.2.5.1.3 "><p id="dcs-api-0312010__p14352135434710">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312010__p134613408221">DCS instance specification code.</p>
|
|
<p id="dcs-api-0312010__p202155516317">This parameter is optional for DCS Redis 3.0 instances.</p>
|
|
<p id="dcs-api-0312010__p4265174416227">This parameter is mandatory for DCS Redis 4.0 and Redis 5.0 instances.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="dcs-api-0312010__p6453215191514"><strong id="dcs-api-0312010__b198274440453">Example request</strong></p>
|
|
<ul id="dcs-api-0312010__ul17293211135"><li id="dcs-api-0312010__li373932171312">Request URL:<pre class="screen" id="dcs-api-0312010__screen1533514392311">POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/extend</pre>
|
|
</li></ul>
|
|
<ul id="dcs-api-0312010__ul980018203149"><li id="dcs-api-0312010__li168004203145">Example:<pre class="screen" id="dcs-api-0312010__screen173701428183218">{
|
|
"spec_code":"redis.single.au1.large.4",
|
|
"new_capacity":4,
|
|
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312010__section11426254461"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312010__p16935155054116"><strong id="dcs-api-0312010__b75781756124515">Response parameters</strong></p>
|
|
<p id="dcs-api-0312010__p18780149144413">None</p>
|
|
<p class="msonormal" id="dcs-api-0312010__p1830212192316"><strong id="dcs-api-0312010__b2061312594457">Example response</strong></p>
|
|
<p id="dcs-api-0312010__p1844711114513">None</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312010__section5301161961211"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312010__p3301319121217"><a href="#dcs-api-0312010__table8301101911215">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-0312010__table8301101911215"></a><a name="table8301101911215"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312010__table8301101911215" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312010__row11302101915124"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312010__p73021519101210">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-0312010__p830281981219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312010__row182271411314"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312010__p168231014739">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312010__p38237146312">Scale-up task submitted successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312003.html">Lifecycle Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|