doc-exports/docs/cce/api-ref/cce_02_0375.html
Dong, Qiu Jian 3bfd56205d CCE API update -20240401 version
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
2024-04-16 09:26:07 +00:00

106 lines
8.7 KiB
HTML

<a name="cce_02_0375"></a><a name="cce_02_0375"></a>
<h1 class="topictitle1">Waking Up a Cluster</h1>
<div id="body32001227"><div class="section" id="cce_02_0375__en-us_topic_0277836749_section106741124165117"><h4 class="sectiontitle">Function</h4><p id="cce_02_0375__en-us_topic_0277836749_p96747240518">This API is used to wake up a hibernated cluster.</p>
</div>
<div class="section" id="cce_02_0375__en-us_topic_0277836749_section116751724145111"><h4 class="sectiontitle">URI</h4><p id="cce_02_0375__en-us_topic_0277836749_p467518245518">POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/awake</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0375__en-us_topic_0277836749_table46761724115117" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="cce_02_0375__en-us_topic_0277836749_row18675624145112"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="cce_02_0375__en-us_topic_0277836749_p96761024155113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="cce_02_0375__en-us_topic_0277836749_p6676112416519">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="cce_02_0375__en-us_topic_0277836749_p767615248515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="cce_02_0375__en-us_topic_0277836749_p4676182435110">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0375__en-us_topic_0277836749_row1967522415118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cce_02_0375__en-us_topic_0277836749_p14676172445111">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cce_02_0375__en-us_topic_0277836749_p19676192414519">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cce_02_0375__en-us_topic_0277836749_p5677724105115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cce_02_0375__en-us_topic_0277836749_p267752485114">Project ID. For details about how to obtain the project ID, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
</td>
</tr>
<tr id="cce_02_0375__en-us_topic_0277836749_row4675224125111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="cce_02_0375__en-us_topic_0277836749_p19677122435113">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="cce_02_0375__en-us_topic_0277836749_p867714246512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="cce_02_0375__en-us_topic_0277836749_p19677102425117">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="cce_02_0375__en-us_topic_0277836749_p1867722417512">Cluster ID. For details about how to obtain the cluster ID, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cce_02_0375__en-us_topic_0277836749_section7677624165111"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0375__en-us_topic_0277836749_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="cce_02_0375__en-us_topic_0277836749_row76781224125117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="cce_02_0375__en-us_topic_0277836749_p1367812410517">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="cce_02_0375__en-us_topic_0277836749_p17679824105119">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="cce_02_0375__en-us_topic_0277836749_p156799240518">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="cce_02_0375__en-us_topic_0277836749_p1667915248515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0375__en-us_topic_0277836749_row16678424135117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cce_02_0375__en-us_topic_0277836749_p156791724175115">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cce_02_0375__en-us_topic_0277836749_p13679192419517">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cce_02_0375__en-us_topic_0277836749_p66791624175115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cce_02_0375__en-us_topic_0277836749_p106801524105119">Message body type (format).</p>
<p id="cce_02_0375__en-us_topic_0277836749_p0680924195114">Default: <strong id="cce_02_0375__en-us_topic_0277836749_b868010245514">application/json</strong></p>
</td>
</tr>
<tr id="cce_02_0375__en-us_topic_0277836749_row18678112415513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="cce_02_0375__en-us_topic_0277836749_p168019248519">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="cce_02_0375__en-us_topic_0277836749_p13680324195115">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="cce_02_0375__en-us_topic_0277836749_p17680172412519">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="cce_02_0375__en-us_topic_0277836749_p19681152410519">Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this field is mandatory and must be set to a user token. For details about how to obtain a token, see <a href="cce_02_0004.html">API Usage Guidelines</a>.</p>
<p id="cce_02_0375__en-us_topic_0277836749_p568117247518">Maximum: <strong id="cce_02_0375__en-us_topic_0277836749_b9681724135116">16384</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cce_02_0375__en-us_topic_0277836749_section8681182455115"><h4 class="sectiontitle">Response Parameters</h4><p id="cce_02_0375__en-us_topic_0277836749_p176810246517">None</p>
</div>
<div class="section" id="cce_02_0375__en-us_topic_0277836749_section9682102414511"><h4 class="sectiontitle">Example Requests</h4><p id="cce_02_0375__en-us_topic_0277836749_p1768292418518">None</p>
</div>
<div class="section" id="cce_02_0375__en-us_topic_0277836749_section468242417519"><h4 class="sectiontitle">Example Responses</h4><p id="cce_02_0375__en-us_topic_0277836749_p368210243519">None</p>
</div>
<div class="section" id="cce_02_0375__en-us_topic_0277836749_section8682182425119"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0375__en-us_topic_0277836749_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cce_02_0375__en-us_topic_0277836749_row46831624125112"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="cce_02_0375__en-us_topic_0277836749_p166831724195118">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="cce_02_0375__en-us_topic_0277836749_p176831824205115">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="cce_02_0375__en-us_topic_0277836749_row268372411515"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="cce_02_0375__en-us_topic_0277836749_p1468422416515">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="cce_02_0375__en-us_topic_0277836749_p1668402465116">The cluster wakeup job is successfully delivered. Keep querying the cluster status. When the cluster status changes to <strong id="cce_02_0375__en-us_topic_0277836749_b17684182495117">Available</strong>, the cluster is woken up successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="cce_02_0375__en-us_topic_0277836749_section10684724175111"><h4 class="sectiontitle">Error Codes</h4><p id="cce_02_0375__en-us_topic_0277836749_p7684112435115">See <a href="cce_02_0250.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0092.html">Cluster Management</a></div>
</div>
</div>