forked from docs/doc-exports
Dong, Qiu Jian
3bfd56205d
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>
108 lines
9.0 KiB
HTML
108 lines
9.0 KiB
HTML
<a name="cce_02_0374"></a><a name="cce_02_0374"></a>
|
|
|
|
<h1 class="topictitle1">Hibernating a Cluster</h1>
|
|
<div id="body32001227"><div class="section" id="cce_02_0374__en-us_topic_0277836753_section355372435116"><h4 class="sectiontitle">Function</h4><p id="cce_02_0374__en-us_topic_0277836753_p13553102417517">This API is used to hibernate a running cluster.</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0374__en-us_topic_0277836753_section35531624135115"><h4 class="sectiontitle">Constraints</h4><ol id="cce_02_0374__en-us_topic_0277836753_ol135538242511"><li id="cce_02_0374__en-us_topic_0277836753_li19553162415511">After a cluster is hibernated, resources such as workloads cannot be created or managed in the cluster.</li></ol>
|
|
</div>
|
|
<div class="section" id="cce_02_0374__en-us_topic_0277836753_section1255452415519"><h4 class="sectiontitle">URI</h4><p id="cce_02_0374__en-us_topic_0277836753_p125549248516">POST /api/v3/projects/{project_id}/clusters/{cluster_id}/operation/hibernate</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0374__en-us_topic_0277836753_table355592405117" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="cce_02_0374__en-us_topic_0277836753_row9554192411514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="cce_02_0374__en-us_topic_0277836753_p1855511241519">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="cce_02_0374__en-us_topic_0277836753_p185551824155117">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="cce_02_0374__en-us_topic_0277836753_p1855562425118">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="cce_02_0374__en-us_topic_0277836753_p6555172485110">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0374__en-us_topic_0277836753_row17554172420517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cce_02_0374__en-us_topic_0277836753_p85551024185118">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cce_02_0374__en-us_topic_0277836753_p9555202416518">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cce_02_0374__en-us_topic_0277836753_p1255602485111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cce_02_0374__en-us_topic_0277836753_p14556224165111">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_0374__en-us_topic_0277836753_row5554182418514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="cce_02_0374__en-us_topic_0277836753_p15561924155113">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="cce_02_0374__en-us_topic_0277836753_p455652485118">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="cce_02_0374__en-us_topic_0277836753_p95562245514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="cce_02_0374__en-us_topic_0277836753_p1255632417517">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_0374__en-us_topic_0277836753_section7556102475117"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0374__en-us_topic_0277836753_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="cce_02_0374__en-us_topic_0277836753_row135577242516"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="cce_02_0374__en-us_topic_0277836753_p16557182475117">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="cce_02_0374__en-us_topic_0277836753_p17557122425116">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="cce_02_0374__en-us_topic_0277836753_p855772495111">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="cce_02_0374__en-us_topic_0277836753_p65584242514">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0374__en-us_topic_0277836753_row755722475110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cce_02_0374__en-us_topic_0277836753_p10558172445119">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cce_02_0374__en-us_topic_0277836753_p17558424135112">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cce_02_0374__en-us_topic_0277836753_p1355862412518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cce_02_0374__en-us_topic_0277836753_p85582245511">Message body type (format).</p>
|
|
<p id="cce_02_0374__en-us_topic_0277836753_p13558132411515">Default: <strong id="cce_02_0374__en-us_topic_0277836753_b115581624195110">application/json</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0374__en-us_topic_0277836753_row1655714245511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="cce_02_0374__en-us_topic_0277836753_p255872455111">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="cce_02_0374__en-us_topic_0277836753_p195582245514">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="cce_02_0374__en-us_topic_0277836753_p15598247519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="cce_02_0374__en-us_topic_0277836753_p855992417514">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_0374__en-us_topic_0277836753_p35591724145112">Maximum: <strong id="cce_02_0374__en-us_topic_0277836753_b13559424145119">16384</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cce_02_0374__en-us_topic_0277836753_section6559122495115"><h4 class="sectiontitle">Response Parameters</h4><p id="cce_02_0374__en-us_topic_0277836753_p255922413514">None</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0374__en-us_topic_0277836753_section2559324125117"><h4 class="sectiontitle">Example Requests</h4><p id="cce_02_0374__en-us_topic_0277836753_p6559424125118">None</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0374__en-us_topic_0277836753_section955962455111"><h4 class="sectiontitle">Example Responses</h4><p id="cce_02_0374__en-us_topic_0277836753_p1755916242516">None</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0374__en-us_topic_0277836753_section35591240519"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0374__en-us_topic_0277836753_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="cce_02_0374__en-us_topic_0277836753_row10560124125115"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="cce_02_0374__en-us_topic_0277836753_p4560192416516">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="cce_02_0374__en-us_topic_0277836753_p175601924135119">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0374__en-us_topic_0277836753_row65602024105119"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="cce_02_0374__en-us_topic_0277836753_p4560192465115">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="cce_02_0374__en-us_topic_0277836753_p1756032410513">The cluster hibernation job is successfully delivered. Keep querying the cluster status. When the cluster status changes to <strong id="cce_02_0374__en-us_topic_0277836753_b11560724145113">Hibernation</strong>, the cluster is hibernated.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cce_02_0374__en-us_topic_0277836753_section195612243511"><h4 class="sectiontitle">Error Codes</h4><p id="cce_02_0374__en-us_topic_0277836753_p15611924145115">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>
|
|
|