vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dataartsstudio/api-ref/StopCluster.html
Xiong, Chen Xiao f2733178cc DataArts API 20230329 version 
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2023-06-29 16:21:21 +00:00

214 lines
14 KiB
HTML
Raw Blame History

<a name="StopCluster"></a><a name="StopCluster"></a>
<h1 class="topictitle1">Stopping a Cluster</h1>
<div id="body1329198192513"><div class="section" id="StopCluster__section112928182515"><h4 class="sectiontitle">Function</h4><p id="StopCluster__p1530382255">This API is used to stop a cluster.</p>
</div>
<div class="section" id="StopCluster__section19324812516"><h4 class="sectiontitle">URI</h4><p id="StopCluster__p1132188142511">POST /v1.1/{project_id}/clusters/{cluster_id}/action</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopCluster__table133812872512" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="StopCluster__row636488254"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="StopCluster__p173910819255">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="StopCluster__p44020811251">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="StopCluster__p3412811257">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="StopCluster__p1341381259">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="StopCluster__row936158132513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="StopCluster__p1441118112520">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="StopCluster__p1042287254">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="StopCluster__p942188258">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="StopCluster__p143108152513">Project ID</p>
</td>
</tr>
<tr id="StopCluster__row1371814253"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="StopCluster__p14431985257">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="StopCluster__p54418882518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="StopCluster__p2452815255">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="StopCluster__p154515814255">Cluster ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="StopCluster__section446289251"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopCluster__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="StopCluster__row13471188253"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="StopCluster__p148384256">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="StopCluster__p114810882518">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="StopCluster__p164928152520">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="StopCluster__p8492810255">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="StopCluster__row16472862519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="StopCluster__p85038162514">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="StopCluster__p185010812519">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="StopCluster__p2501085253">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="StopCluster__p205116842519">User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopCluster__request_CdmStopClusterReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="StopCluster__row85268202512"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="StopCluster__p1953188132512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="StopCluster__p65316811256">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="StopCluster__p453128192517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="StopCluster__p95418152519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="StopCluster__row155214812250"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="StopCluster__p14541789258">stop</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="StopCluster__p25428112512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="StopCluster__p195528102513"><a href="#StopCluster__request_stop">stop</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="StopCluster__p108132485264">Cluster stop operation, which defines the parameters for stopping a cluster.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="StopCluster__request_stop"></a><a name="request_stop"></a><table cellpadding="4" cellspacing="0" summary="" id="StopCluster__request_stop" frame="border" border="1" rules="all"><caption><b>Table 4 </b>stop</caption><thead align="left"><tr id="StopCluster__row12575815252"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="StopCluster__p1358388251">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="StopCluster__p2059687251">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="StopCluster__p959087252">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="StopCluster__p4601186258">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="StopCluster__row1857128182519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="StopCluster__p126014815252">stopMode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="StopCluster__p176014813255">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="StopCluster__p461198132513">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="StopCluster__p16113812511">Stop mode</p>
<ul id="StopCluster__ul106114862517"><li id="StopCluster__li16216832514"><strong id="StopCluster__b16217862512">IMMEDIATELY</strong>: immediate stop</li><li id="StopCluster__li2625815255"><strong id="StopCluster__b1623872511">GRACEFULLY</strong>: graceful stop</li></ul>
<p id="StopCluster__p106212820251">Enumeration values:</p>
<ul id="StopCluster__ul56348142518"><li id="StopCluster__li166368112513"><strong id="StopCluster__b17631488258">IMMEDIATELY</strong></li><li id="StopCluster__li19631284251"><strong id="StopCluster__b116318172518">GRACEFULLY</strong></li></ul>
</td>
</tr>
<tr id="StopCluster__row175716802516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="StopCluster__p564385258">delayTime</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="StopCluster__p5648817257">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="StopCluster__p965118202512">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="StopCluster__p106558112510">Stop delay, in seconds. This parameter is valid only when <strong id="StopCluster__b146510862517">stopMode</strong> is set to <strong id="StopCluster__b16517815257">GRACEFULLY</strong>. If the value of this parameter is set to <strong id="StopCluster__b4651589255">-1</strong>, the system waits for all jobs to complete and stops accepting new jobs. If the value of this parameter is greater than <strong id="StopCluster__b136520817258">0</strong>, the system stops the cluster after the specified time and stops accepting new jobs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="StopCluster__section16668818251"><h4 class="sectiontitle">Response Parameters</h4><p id="StopCluster__p126615882513"><strong id="StopCluster__b17663813259">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopCluster__response_CdmStartAndStopClusterResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="StopCluster__row1567168172511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="StopCluster__p176817842512">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="StopCluster__p5691481256">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="StopCluster__p186917818252">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="StopCluster__row467138152511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="StopCluster__p1570786250">jobId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="StopCluster__p1470198132511">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="StopCluster__p270158162520">Job ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="StopCluster__section137111842513"><h4 class="sectiontitle">Example Requests</h4><p id="StopCluster__p47111812511">Stopping a Cluster</p>
<pre class="screen" id="StopCluster__screen1073158112519">POST /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/bae65496-643e-47ca-84af-948672de7eeb/action
{
"stop" : {
"stopMode" : "GRACEFULLY",
"delayTime" : -1
}
}</pre>
</div>
<div class="section" id="StopCluster__section4748818254"><h4 class="sectiontitle">Example Responses</h4><p id="StopCluster__p14752862519"><strong id="StopCluster__b197558202515">Status code: 200</strong></p>
<p id="StopCluster__p187512813252">ok</p>
<pre class="screen" id="StopCluster__screen7751289253">{
"jobId" : [ "ff8080815e59d92d015e5b27ccb0004d" ]
}</pre>
</div>
<div class="section" id="StopCluster__section157698162515"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopCluster__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="StopCluster__row5778814258"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="StopCluster__p48014862519">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="StopCluster__p78068132518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="StopCluster__row578198172518"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="StopCluster__p98112832512">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="StopCluster__p1581108172517">ok</p>
</td>
</tr>
<tr id="StopCluster__row10784819253"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="StopCluster__p1482686250">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="StopCluster__p9829852516">Request error.</p>
</td>
</tr>
<tr id="StopCluster__row14781989252"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="StopCluster__p18839862515">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="StopCluster__p18849817257">Authentication failed.</p>
</td>
</tr>
<tr id="StopCluster__row7780832512"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="StopCluster__p9841484256">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="StopCluster__p148420820250">You do not have required permissions to perform this operation.</p>
</td>
</tr>
<tr id="StopCluster__row10783811255"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="StopCluster__p9851989258">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="StopCluster__p11851389254">The requested resource was not found.</p>
</td>
</tr>
<tr id="StopCluster__row57858202512"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="StopCluster__p138511813254">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="StopCluster__p158518822514">An internal service error occurred. For details, see error codes.</p>
</td>
</tr>
<tr id="StopCluster__row47915811251"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="StopCluster__p4866892517">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="StopCluster__p286108132516">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="StopCluster__section198618817251"><h4 class="sectiontitle">Error Codes</h4><p id="StopCluster__p12876872518">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000_3.html">Cluster Management</a></div>
</div>
</div>
View Git Blame Copy Permalink