forked from docs/doc-exports
Wuwan, Qi
8675132585
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Wuwan, Qi <wuwanqi1@noreply.gitea.eco.tsi-dev.otc-service.com>
131 lines
8.3 KiB
HTML
131 lines
8.3 KiB
HTML
<a name="css_03_0091"></a><a name="css_03_0091"></a>
|
|
|
|
<h1 class="topictitle1">Configuring the Security Mode.</h1>
|
|
<div id="body0000001526505769"><div class="section" id="css_03_0091__section124693713314"><h4 class="sectiontitle">Function</h4><p id="css_03_0091__p324714371311">This API is used to configure the security mode of a cluster.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0091__section4252203753119"><h4 class="sectiontitle">URI</h4><p id="css_03_0091__p7253137103112">POST /v1.0/{project_id}/clusters/{cluster_id}/mode/change</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0091__table625693773119" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="css_03_0091__row19254437133119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0091__p32561137173111">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0091__p10257137153116">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0091__p025719378318">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0091__p5258193763116">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0091__row2254103712311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0091__p725913372313">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0091__p1126083720314">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0091__p102601037123114">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0091__p12611937133110">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0091__row17254137193120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0091__p17262037113110">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0091__p15264637153113">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0091__p15265437143116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0091__p1026623773119">Cluster ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0091__section626883743112"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0091__request_changeModeReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="css_03_0091__row32701937143115"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="css_03_0091__p1627313719316">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="css_03_0091__p9274183773119">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="css_03_0091__p1427533793117">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="css_03_0091__p1627643714315">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0091__row1327023716313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0091__p1327719371318">authorityEnable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0091__p427853717313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0091__p72791737203119">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0091__p028053733114">Security mode. Its value can be:</p>
|
|
<ul id="css_03_0091__ul192802037203112"><li id="css_03_0091__li72812378313">true: enabled</li><li id="css_03_0091__li22811537203114">false: disabled Default value: true</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0091__row62701378313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0091__p10283143763115">adminPwd</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0091__p9283183710314">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0091__p52843371315">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0091__p13285123793110">Cluster password in security mode.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0091__row172701037153116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="css_03_0091__p32851137123119">httpsEnable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="css_03_0091__p18286173715313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="css_03_0091__p828743716318">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="css_03_0091__p1428763793113">Enable HTTPS. Its value can be:</p>
|
|
<ul id="css_03_0091__ul1828813733116"><li id="css_03_0091__li02881937173111">true: enabled</li><li id="css_03_0091__li162891737123115">false: disabled Default value: true</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0091__section1829033773116"><h4 class="sectiontitle">Response Parameters</h4><p id="css_03_0091__p192907370311">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0091__section13291203712316"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="css_03_0091__screen629243717312">POST /v1.0/{project_id}/clusters/{cluster_id}/mode/change
|
|
|
|
{
|
|
"authorityEnable" : true,
|
|
"adminPwd" : "xxxx1234",
|
|
"httpsEnable" : true
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0091__section1229753783117"><h4 class="sectiontitle">Example Responses</h4><p id="css_03_0091__p5298173716312">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0091__section6299173733116"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0091__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="css_03_0091__row9300337113118"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="css_03_0091__p530113375316">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="css_03_0091__p33021637193120">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0091__row1430014379319"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0091__p9303183733112">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0091__p230314375310">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0091__row1730018375313"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0091__p1430413371318">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0091__p1230511375318">Invalid request.</p>
|
|
<p id="css_03_0091__p113054375315">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0091__row13001437173115"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="css_03_0091__p33063372316">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="css_03_0091__p1830703716314">The requested resource could not be found.</p>
|
|
<p id="css_03_0091__p1730703716319">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0008.html">Cluster Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|