1
0
forked from docs/doc-exports
doc-exports/docs/sdrs/api-ref/sdrs_05_0509.html
Wei, Hongmin ab56d080fb SDRS API initial version
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-26 13:51:50 +00:00

217 lines
17 KiB
HTML

<a name="sdrs_05_0509"></a><a name="sdrs_05_0509"></a>
<h1 class="topictitle1">Deleting an NIC from a Protected Instance</h1>
<div id="body1524795306610"><div class="section" id="sdrs_05_0509__en-us_topic_0079693002_section34649765"><h4 class="sectiontitle">Function</h4><p id="sdrs_05_0509__en-us_topic_0079693002_p9084369">This API is used to delete an NIC from the specified protected instance.</p>
</div>
<div class="section" id="sdrs_05_0509__section137521015392"><h4 class="sectiontitle">Constraints and Limitations</h4><ul id="sdrs_05_0509__ul9792338143"><li id="sdrs_05_0509__li17792203191417"><strong id="sdrs_05_0509__b1177592515714">status</strong> of the protection group must be <strong id="sdrs_05_0509__b1877782535717">available</strong> or <strong id="sdrs_05_0509__b1779192525712">protected</strong>.</li><li id="sdrs_05_0509__li118671667141"><strong id="sdrs_05_0509__b6351112925718">status</strong> of the protected instance must be <strong id="sdrs_05_0509__b13529295572">available</strong> or <strong id="sdrs_05_0509__b7353172919577">protected</strong>.</li><li id="sdrs_05_0509__li1544493149">The primary NIC cannot be deleted.</li></ul>
</div>
<div class="section" id="sdrs_05_0509__en-us_topic_0079693002_section39390935"><h4 class="sectiontitle">URI</h4><ul id="sdrs_05_0509__en-us_topic_0079693002_ul52084342"><li id="sdrs_05_0509__en-us_topic_0079693002_li66105898">URI format<p id="sdrs_05_0509__en-us_topic_0079693002_p212314194247"><a name="sdrs_05_0509__en-us_topic_0079693002_li66105898"></a><a name="en-us_topic_0079693002_li66105898"></a>POST /v1/{project_id}/protected-instances/{protected_instance_id}/nic/delete</p>
</li><li id="sdrs_05_0509__en-us_topic_0079693002_li52977523">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0509__en-us_topic_0079693002_table63321005" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0509__en-us_topic_0079693002_row37593218"><th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="sdrs_05_0509__p1048762312315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="sdrs_05_0509__p7487122316318">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="sdrs_05_0509__p1648718231317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="sdrs_05_0509__p14872230312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0509__en-us_topic_0079693002_row29123463"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="sdrs_05_0509__p104887232312">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="sdrs_05_0509__p948818233317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="sdrs_05_0509__p2488523123110">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="sdrs_05_0509__p0488923163111">Specifies the project ID.</p>
</td>
</tr>
<tr id="sdrs_05_0509__row15345218175113"><td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="sdrs_05_0509__p11488182393112">protected_instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="sdrs_05_0509__p1348802313118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="sdrs_05_0509__p16488112333117">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="sdrs_05_0509__p144885238312">Specifies the ID of a protected instance.</p>
<p id="sdrs_05_0509__p15532185319462">You can obtain this value by calling the API described in <a href="sdrs_05_0503.html">Querying Protected Instances</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0509__en-us_topic_0079693002_section18974100"><h4 class="sectiontitle">Request</h4><ul id="sdrs_05_0509__en-us_topic_0079693002_ul13105749"><li id="sdrs_05_0509__en-us_topic_0079693002_li50842877">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0509__en-us_topic_0079693002_table54932709" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0509__en-us_topic_0079693002_row41882373"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="sdrs_05_0509__en-us_topic_0079693002_p8696081161227">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="sdrs_05_0509__en-us_topic_0079693002_p33293980161227">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="sdrs_05_0509__en-us_topic_0079693002_p12457872161227">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="sdrs_05_0509__en-us_topic_0079693002_p2454675161227">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0509__en-us_topic_0079693002_row27990155"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="sdrs_05_0509__p234273715110">nic_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="sdrs_05_0509__p3342637145114">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="sdrs_05_0509__p133421379518">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="sdrs_05_0509__p83426373517">Specifies the port ID of the NIC.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="sdrs_05_0509__en-us_topic_0079693002_ul53989823"><li id="sdrs_05_0509__en-us_topic_0079693002_li16146366">Example request<div class="p" id="sdrs_05_0509__p1943828104817"><a name="sdrs_05_0509__en-us_topic_0079693002_li16146366"></a><a name="en-us_topic_0079693002_li16146366"></a>POST https://{Endpoint}/v1/{project_id}/protected-instances/00000000632302f501632305f63c000e/nic/delete<pre class="screen" id="sdrs_05_0509__screen49031813114817">{
"nic_id": "f0ac4394-7e4a-4409-9701-husge283dbc3"
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="sdrs_05_0509__en-us_topic_0079693002_section36549175"><h4 class="sectiontitle">Response</h4><ul id="sdrs_05_0509__en-us_topic_0079693002_ul48735027"><li id="sdrs_05_0509__en-us_topic_0079693002_li35962059">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0509__table155991608555" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0509__row460510055518"><th align="left" class="cellrowborder" valign="top" width="29.07%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="sdrs_05_0509__p56078010555">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.44%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="sdrs_05_0509__p961219016552">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.49%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="sdrs_05_0509__p186139012557">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0509__row86164025512"><td class="cellrowborder" valign="top" width="29.07%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="sdrs_05_0509__p7804115914511">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.44%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="sdrs_05_0509__p31457773214">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="sdrs_05_0509__p101451710326">Specifies the job ID.</p>
<p id="sdrs_05_0509__p380084725217">This is a returned parameter when the asynchronous API command is issued successfully. For details about the task execution result, see the description in <a href="sdrs_05_0101.html">Querying the Job Status</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sdrs_05_0509__en-us_topic_0079693002_li66450672">Example response<pre class="screen" id="sdrs_05_0509__screen94191723143214">{
"job_id": "0000000011db92d70162db9d20df32ch"
}</pre>
<p id="sdrs_05_0509__p58391157151813">Or</p>
<pre class="screen" id="sdrs_05_0509__screen11729035197">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="sdrs_05_0509__p083975711815">In this example, <strong id="sdrs_05_0509__b2328252195316">error</strong> represents a general error, including <strong id="sdrs_05_0509__b6329165219536">badrequest</strong> (shown below) and <strong id="sdrs_05_0509__b233055219532">itemNotFound</strong>.</p>
<pre class="screen" id="sdrs_05_0509__screen22331871919">{
"badrequest": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="sdrs_05_0509__en-us_topic_0079693002_section60507121"><h4 class="sectiontitle">Returned Values</h4><ul id="sdrs_05_0509__en-us_topic_0079693002_ul18743339"><li id="sdrs_05_0509__li37400248244">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0509__sdrs_05_0101_table4315991194956" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0509__sdrs_05_0101_row2336641294956"><th align="left" class="cellrowborder" valign="top" width="42.59%" id="mcps1.3.6.2.1.1.1.3.1.1"><p id="sdrs_05_0509__sdrs_05_0101_p1363125894956">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.410000000000004%" id="mcps1.3.6.2.1.1.1.3.1.2"><p id="sdrs_05_0509__sdrs_05_0101_p3039012494956">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0509__sdrs_05_0101_row507566794956"><td class="cellrowborder" valign="top" width="42.59%" headers="mcps1.3.6.2.1.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p847584694956">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.410000000000004%" headers="mcps1.3.6.2.1.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p1545496394956">The server has accepted the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sdrs_05_0509__li13951479">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sdrs_05_0509__sdrs_05_0101_table22458872203835" frame="border" border="1" rules="all"><thead align="left"><tr id="sdrs_05_0509__sdrs_05_0101_row35704554203835"><th align="left" class="cellrowborder" valign="top" width="43.419999999999995%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="sdrs_05_0509__sdrs_05_0101_p6387753203835">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.58%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="sdrs_05_0509__sdrs_05_0101_p47646009203835">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sdrs_05_0509__sdrs_05_0101_row34121538203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p12381163203835">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p63350108203835">The server failed to process the request.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row33280063203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p11330608203835">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p45364094203835">You must enter a username and the password to access the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row5623667203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p52863895203835">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p54117066203835">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row17291554203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p58438642203835">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p35909542203835">The server could not find the requested page.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row54750425203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p5599455203835">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p50902717203835">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row55471277203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p63988484203835">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p15684678203835">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row6944380203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p25623884203835">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p62268733203835">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row23547689203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p28314670203835">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p11786919203835">The request timed out.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row38973411203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p2729702203835">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p19779281203835">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row43795805203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p57799353203835">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p51235984203835">Failed to complete the request because of a service error.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row58470678203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p38504500203835">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p31856770203835">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row18275474203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p3918444203835">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p48958538203835">Failed to complete the request because the server receives an invalid response from an upstream server.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row37973662203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p55967806203835">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p37098455203835">Failed to complete the request because the system is unavailable.</p>
</td>
</tr>
<tr id="sdrs_05_0509__sdrs_05_0101_row65450640203835"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sdrs_05_0509__sdrs_05_0101_p67010448203835">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sdrs_05_0509__sdrs_05_0101_p59137180203835">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sdrs_05_0500.html">Protected Instance</a></div>
</div>
</div>