vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/api-ref/dws_02_0053.html
Lu, Huayi 3d88b677fd DWS API 830.201 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-05-10 13:18:08 +00:00

151 lines
17 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001231472767"></a><a name="EN-US_TOPIC_0000001231472767"></a>
<h1 class="topictitle1">Scaling Out Clusters</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_s7aa3de1b44f14c0487bab690bb5702d6"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p14656161715131">This API is used to scale out clusters.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_s9db56e76e7694a5cbfd993c7d1db0606"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_u4cf609fc053741998eedd89cf45caf2c"><li id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_l2b8b579a356f4f1f8118dc22b4a322e5">URI format<pre class="screen" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_screen1624519311588">POST /v1.0/{project_id}/clusters/{cluster_id}/resize</pre>
</li><li id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_l04279980b92848f4b97e6cdbfac33319">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_tb301b46821994ee6ae8cb5d508bfd564" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_r09f2cf7e302f4b1197b293cb5b91aa42"><th align="left" class="cellrowborder" valign="top" width="20.73%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_ad24f94544e3448e588d569b4cf5d3df1"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b772914305315">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.18%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a23ce55ff78b64009b06caaddea7be777"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b8117321319">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.4%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_aa68a5c620b7741ebb873bc22f4abf72b"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b122633102317">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.690000000000005%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a5c07a285f796424888ea8c9b215ef172"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b1080593319233">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_rd49c40cc2e534fb38fc1ce2158dda6da"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_adf89366c8cdf490b91f7ab0b1aa4c9d7">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.18%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a03a216c626564f1eb88d9562a41ee374">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.4%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a9bf19da6d557419eb7768b4c0d4dc441">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.690000000000005%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p1266145715419"><span id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_text1863816153111">Project ID</span>. For details about how to obtain the ID, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_r3f1019a86e164120957b6c78183aed5c"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_ac8206c593fb6478d90922a1317be1af3">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.18%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a723b9ebdf5d14520ac6db771eea07716">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.4%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a42225196447a466a8b27488e9f840018">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.690000000000005%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a3c9219ff8f544b6db2665fbab0057dab">ID of the cluster to be scaled out. For details about how to obtain the ID, see <a href="dws_02_00068.html">Obtaining the Cluster ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_sa64d5fde1cb94be29689b1aab5bc2bb2"><h4 class="sectiontitle">Request Message</h4><ul id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_u56175bf842bc4ad4955c9629175fdcf6"><li id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_le3efc5a2349b4c1084d325bac163560c">Request example<p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p55371461532"><a name="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_le3efc5a2349b4c1084d325bac163560c"></a><a name="en-us_topic_0000001098816630_le3efc5a2349b4c1084d325bac163560c"></a>scale_out sample API is as follows:</p>
<pre class="screen" id="EN-US_TOPIC_0000001231472767__screen139907291183">POST https://{Endpoint}/v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/resize
{
"scale_out" : {
"count" : 3
}
}</pre>
</li></ul>
<ul id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_uf93db65bd61b4726a254602f9dca6091"><li id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_lae6e367885da4d8a9f688f856f1553fc">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_tc32f843a9ead4035a871c86d7a4846cf" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_rcf972ba57cb945bca28c72ec13f32fb4"><th align="left" class="cellrowborder" valign="top" width="20.330000000000002%" id="mcps1.3.3.3.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a04409112453b4054b07ce0e5d3fd7aac"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b11207130105416">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.18%" id="mcps1.3.3.3.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_ac42ccdeeb5ca426cba55f7d3103a3e4d"><strong id="EN-US_TOPIC_0000001231472767__b379706145">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.56%" id="mcps1.3.3.3.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a3be50d1d99d643778bb995586c600e14"><strong id="EN-US_TOPIC_0000001231472767__b1932317849">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.93%" id="mcps1.3.3.3.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a028e0ec2d58b47edb787e6e49333ec7f"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b14512172185413">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_row74689615383"><td class="cellrowborder" valign="top" width="20.330000000000002%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p6469763388">scale_out</p>
</td>
<td class="cellrowborder" valign="top" width="20.18%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p54727617384">No</p>
</td>
<td class="cellrowborder" valign="top" width="19.56%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p204722619389"><a href="#EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_table18225133616155">ScaleOut</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="39.93%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p14721867388">Scale out an object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_table18225133616155"></a><a name="en-us_topic_0000001098816630_table18225133616155"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_table18225133616155" frame="border" border="1" rules="all"><caption><b>Table 3 </b>ScaleOut</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_row0226123619151"><th align="left" class="cellrowborder" valign="top" width="20.849999999999998%" id="mcps1.3.3.3.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p1226193641515"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b713819463220">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.299999999999999%" id="mcps1.3.3.3.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p1922673616154"><strong id="EN-US_TOPIC_0000001231472767__b237729877">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.64%" id="mcps1.3.3.3.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p2226103611520"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b11944104512410">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.21%" id="mcps1.3.3.3.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p9226133614153"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b577619462246">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_row22261136141510"><td class="cellrowborder" valign="top" width="20.849999999999998%" headers="mcps1.3.3.3.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p182263361154">count</p>
</td>
<td class="cellrowborder" valign="top" width="10.299999999999999%" headers="mcps1.3.3.3.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p12226173631519">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.64%" headers="mcps1.3.3.3.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p1022611361152">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.21%" headers="mcps1.3.3.3.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_p1022633612152">Number of nodes to be added</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_saf8285fea2964e558a059d985c498559"><h4 class="sectiontitle">Response Message</h4><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_en-us_topic_0067625516_p070316818262">Example response</p>
<pre class="screen" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_sabffaf8806d04531be3a32b013bf56e3">status CODE 200</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_s318da95b204f47c4bef42e78b54a9089"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_u6b27dfff47284d9eb4526aa606fd904d"><li id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_lc3e480c720a44ace9824ad63cbfe527d">Normal<p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_afe8c3c6bf90a42eca6518dde64ab22ed"><a name="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_lc3e480c720a44ace9824ad63cbfe527d"></a><a name="en-us_topic_0000001098816630_lc3e480c720a44ace9824ad63cbfe527d"></a>200</p>
</li><li id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_la038d54e5c39431386902a311ea0a9bd">Exception
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_tfd7a877a4eed4992a077edb0bb8f7352" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Returned values</caption><thead align="left"><tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_red5a03b5306f46e0900cacc8c992c838"><th align="left" class="cellrowborder" valign="top" width="31.15%" id="mcps1.3.5.2.2.1.2.3.1.1"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a72e8066c2a994394ba0ece17bd467376"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b11881916103319">Returned Value</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="68.85%" id="mcps1.3.5.2.2.1.2.3.1.2"><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a2982bcdae3bb45f8b90b4baeef64cc05"><strong id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_b1174045416244">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_r5d0fed0ce30740a49f01318c52c42592"><td class="cellrowborder" valign="top" width="31.15%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_ae37fb97120e94cbea677f88d0ab4edbd">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="68.85%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_ac2c1c94571004267a7297152e7edb7fc">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_r45192eae966e4de885d09edc4b3eee3c"><td class="cellrowborder" valign="top" width="31.15%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_adfc757440c4849e09a2516b04e8a1d01">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="68.85%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_af986420c033c45dea198eb80d6c07471">Authorization failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_r41d8f90f2d864d6b92339cf01794c677"><td class="cellrowborder" valign="top" width="31.15%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a24892b03923545f48aa72a00f90ac7d3">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="68.85%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a6ac5aa0c4d654b33aa51c2193a5b6e83">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_rb2e58285b54e40058c475f72290b1e68"><td class="cellrowborder" valign="top" width="31.15%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a3a8f1a544d714b28b85c80856fe07ae5">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="68.85%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a75dc6f72a9044650829d4fd51c48beb5">No resources found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_r02aba20d19bc40bea95f3b9dc09780c1"><td class="cellrowborder" valign="top" width="31.15%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_ade198c372ecb4b6786369a2cd1d0a5dc">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="68.85%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_ad8ec7dfac3ae464f86a085852ac0db58">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_r77f8af8054384d23bf198428f13a207b"><td class="cellrowborder" valign="top" width="31.15%" headers="mcps1.3.5.2.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a73100e054b9840dd80134200f3624a23">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="68.85%" headers="mcps1.3.5.2.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001231472767__en-us_topic_0000001098816630_a7d16065e572f480a95470cafcc622e7b">The service is unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0017.html">Cluster Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink