doc-exports/docs/deh/api-ref/deh_02_0023.html
Hasko, Vladimir ba34ad4eaa initial import of DEH API
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2022-09-07 10:09:05 +00:00

104 lines
8.0 KiB
HTML

<a name="deh_02_0023"></a><a name="deh_02_0023"></a>
<h1 class="topictitle1">Modifying DeH Attributes</h1>
<div id="body1512563929533"><div class="section" id="deh_02_0023__section2129750"><h4 class="sectiontitle">Function</h4><p id="deh_02_0023__p52084342">This API is used to modify the <strong id="deh_02_0023__b1455613817193">auto_placement</strong> and <strong id="deh_02_0023__b44812015141914">name</strong> attributes of a DeH.</p>
</div>
<div class="section" id="deh_02_0023__section19167756"><h4 class="sectiontitle">URI</h4><p id="deh_02_0023__p1459863120307">PUT /v1.0/{project_id}/dedicated-hosts/{dedicated_host_id}</p>
<p id="deh_02_0023__p1256624114553"><a href="#deh_02_0023__table572214121015">Table 1</a> describes the parameters.</p>
<div class="tablenoborder"><a name="deh_02_0023__table572214121015"></a><a name="table572214121015"></a><table cellpadding="4" cellspacing="0" summary="" id="deh_02_0023__table572214121015" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters description</caption><thead align="left"><tr id="deh_02_0023__row572516410109"><th align="left" class="cellrowborder" valign="top" width="21.23787621237876%" id="mcps1.3.2.4.2.5.1.1"><p id="deh_02_0023__p107252049107"><strong id="deh_02_0023__b212574719219">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.44765523447655%" id="mcps1.3.2.4.2.5.1.2"><p id="deh_02_0023__p726975522919"><strong id="deh_02_0023__b105121348202117">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.48755124487551%" id="mcps1.3.2.4.2.5.1.3"><p id="deh_02_0023__p072564201017"><strong id="deh_02_0023__b549624952117">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.826917308269174%" id="mcps1.3.2.4.2.5.1.4"><p id="deh_02_0023__p47253421017"><strong id="deh_02_0023__b1834714506210">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="deh_02_0023__row107256481017"><td class="cellrowborder" valign="top" width="21.23787621237876%" headers="mcps1.3.2.4.2.5.1.1 "><p id="deh_02_0023__p1872514451016">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.44765523447655%" headers="mcps1.3.2.4.2.5.1.2 "><p id="deh_02_0023__p12269175511291">String</p>
</td>
<td class="cellrowborder" valign="top" width="24.48755124487551%" headers="mcps1.3.2.4.2.5.1.3 "><p id="deh_02_0023__p147251646108">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.4.2.5.1.4 "><p id="deh_02_0023__p6725747104">Specifies the project ID.</p>
<p id="deh_02_0023__p7376194915119">For details about how to obtain the project ID, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328009.html" target="_blank" rel="noopener noreferrer">Obtaining Required Information</a>.</p>
</td>
</tr>
<tr id="deh_02_0023__row184436404555"><td class="cellrowborder" valign="top" width="21.23787621237876%" headers="mcps1.3.2.4.2.5.1.1 "><p id="deh_02_0023__p164455404556">dedicated_host_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.44765523447655%" headers="mcps1.3.2.4.2.5.1.2 "><p id="deh_02_0023__p29241051175512">String</p>
</td>
<td class="cellrowborder" valign="top" width="24.48755124487551%" headers="mcps1.3.2.4.2.5.1.3 "><p id="deh_02_0023__p1592535185519">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.4.2.5.1.4 "><p id="deh_02_0023__p1544524011550">Specifies the DeH ID.</p>
<p id="deh_02_0023__p858154817367">You can obtain the DeH ID from the DeH console or using the <a href="deh_02_0020.html">Querying DeHs</a> API.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="deh_02_0023__section14650458"><h4 class="sectiontitle">Request</h4><ul id="deh_02_0023__ul1815111380242"><li id="deh_02_0023__li1151938172417">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="deh_02_0023__table658441013351" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="deh_02_0023__row1958514103351"><th align="left" class="cellrowborder" valign="top" width="16.259999999999998%" id="mcps1.3.3.2.1.1.2.6.1.1"><p id="deh_02_0023__p63867222355"><strong id="deh_02_0023__b76877419229">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.72%" id="mcps1.3.3.2.1.1.2.6.1.2"><p id="deh_02_0023__p2038602293516"><strong id="deh_02_0023__b117919712226">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.629999999999999%" id="mcps1.3.3.2.1.1.2.6.1.3"><p id="deh_02_0023__p4386182223513"><strong id="deh_02_0023__b13462118112211">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.17%" id="mcps1.3.3.2.1.1.2.6.1.4"><p id="deh_02_0023__p5386192214352"><strong id="deh_02_0023__b270747479">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="36.22%" id="mcps1.3.3.2.1.1.2.6.1.5"><p id="deh_02_0023__p7386322113519"><strong id="deh_02_0023__b19400141010221">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="deh_02_0023__row1658561013353"><td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.3.2.1.1.2.6.1.1 "><p id="deh_02_0023__p133865220359">auto_placement</p>
</td>
<td class="cellrowborder" valign="top" width="15.72%" headers="mcps1.3.3.2.1.1.2.6.1.2 "><p id="deh_02_0023__p738622212358">in</p>
</td>
<td class="cellrowborder" valign="top" width="15.629999999999999%" headers="mcps1.3.3.2.1.1.2.6.1.3 "><p id="deh_02_0023__p1386172233510">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.17%" headers="mcps1.3.3.2.1.1.2.6.1.4 "><p id="deh_02_0023__p19386162223517">No</p>
</td>
<td class="cellrowborder" valign="top" width="36.22%" headers="mcps1.3.3.2.1.1.2.6.1.5 "><p id="deh_02_0023__p138632218354">Specifies whether to allow an ECS to be placed on any available DeH if its DeH ID is not specified during its creation.</p>
<p id="deh_02_0023__p1738652203516">The value can be <strong id="deh_02_0023__b1588844916239">on</strong> or <strong id="deh_02_0023__b1889074982311">off</strong>.</p>
</td>
</tr>
<tr id="deh_02_0023__row13585111033517"><td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.3.2.1.1.2.6.1.1 "><p id="deh_02_0023__p15386162212351">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.72%" headers="mcps1.3.3.2.1.1.2.6.1.2 "><p id="deh_02_0023__p6386182253510">in</p>
</td>
<td class="cellrowborder" valign="top" width="15.629999999999999%" headers="mcps1.3.3.2.1.1.2.6.1.3 "><p id="deh_02_0023__p438682215356">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.17%" headers="mcps1.3.3.2.1.1.2.6.1.4 "><p id="deh_02_0023__p938662263519">No</p>
</td>
<td class="cellrowborder" valign="top" width="36.22%" headers="mcps1.3.3.2.1.1.2.6.1.5 "><p id="deh_02_0023__p33871122133517">Specifies the DeH name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="deh_02_0023__li1313884116247">Example request<pre class="screen" id="deh_02_0023__screen53401596154145">PUT https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-hosts/74259164-e63a-4ad9-9c77-a1bd2c9aa187
{
"dedicated_host": {
"auto_placement": "off",
"name": "DeH_vm3"
}
}</pre>
</li></ul>
</div>
<div class="section" id="deh_02_0023__section64745266"><h4 class="sectiontitle">Response</h4><ul id="deh_02_0023__ul56011919254"><li id="deh_02_0023__li528985375616">Response parameters<p id="deh_02_0023__p6106195917560"><a name="deh_02_0023__li528985375616"></a><a name="li528985375616"></a>None</p>
</li><li id="deh_02_0023__li126011942516">Example response<pre class="screen" id="deh_02_0023__screen915652432816">Http Response Code: 204</pre>
</li></ul>
</div>
<div class="section" id="deh_02_0023__section21768161"><h4 class="sectiontitle">Status Code</h4><p id="deh_02_0023__p33132859">See <a href="deh_02_0016.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="deh_02_0017.html">API</a></div>
</div>
</div>