forked from docs/doc-exports
Chen, Junjie
a03981f7be
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
170 lines
16 KiB
HTML
170 lines
16 KiB
HTML
<a name="dcs-api-0312009"></a><a name="dcs-api-0312009"></a>
|
|
|
|
<h1 class="topictitle1">Batch Deleting DCS Instances</h1>
|
|
<div id="body1500349379430"><div class="section" id="dcs-api-0312009__en-us_topic_0166889613_section0296157125313"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312009__en-us_topic_0166889613_p10415135413">This API is used to delete multiple DCS instances at a time.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312009__en-us_topic_0166889613_section2310177194512"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312009__en-us_topic_0166889613_p1552254314416">DELETE /v1.0/{project_id}/instances?allFailure={allFailure}</p>
|
|
<div class="p" id="dcs-api-0312009__en-us_topic_0166889613_p13578121810355"><a href="#dcs-api-0312009__en-us_topic_0166889613_table4154121820350">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312009__en-us_topic_0166889613_table4154121820350"></a><a name="en-us_topic_0166889613_table4154121820350"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312009__en-us_topic_0166889613_table4154121820350" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312009__en-us_topic_0166889613_row17153191817358"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312009__en-us_topic_0166889613_p993885712414">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312009__en-us_topic_0166889613_p215314189354">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312009__en-us_topic_0166889613_p1715320185352">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312009__en-us_topic_0166889613_p215351873519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312009__en-us_topic_0166889613_row61531718163510"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312009__en-us_topic_0166889613_p51531218183514">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312009__en-us_topic_0166889613_p115311813514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312009__en-us_topic_0166889613_p815391853510">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312009__en-us_topic_0166889613_p1153818143518">Project ID. For details on how to obtain the value of this parameter, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312009__en-us_topic_0166889613_row1358873516587"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312009__en-us_topic_0166889613_p1058923515811">allFailure</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312009__en-us_topic_0166889613_p55892352586">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312009__en-us_topic_0166889613_p12589103595817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312009__en-us_topic_0166889613_p15502183214592">An indicator of whether all DCS instances failed to be created will be deleted. Options:</p>
|
|
<p id="dcs-api-0312009__en-us_topic_0166889613_p329463011582">Options:</p>
|
|
<ul id="dcs-api-0312009__en-us_topic_0166889613_ul2019045014587"><li id="dcs-api-0312009__en-us_topic_0166889613_li10190135045818"><strong id="dcs-api-0312009__en-us_topic_0166889613_b61661321141315">true</strong>: all instances that fail to be created are deleted. In this case, the <strong id="dcs-api-0312009__en-us_topic_0166889613_b1816772120133">instances</strong> parameter in the request can be empty.</li><li id="dcs-api-0312009__en-us_topic_0166889613_li12190950145818"><strong id="dcs-api-0312009__en-us_topic_0166889613_b1861744910131">false</strong> or other values: The DCS instances specified by the instances parameter in the API request will be deleted.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312009__en-us_topic_0166889613_section41195764519"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312009__en-us_topic_0166889613_p269951018401"><strong id="dcs-api-0312009__en-us_topic_0166889613_b109771018212">Request parameters</strong></p>
|
|
<div class="p" id="dcs-api-0312009__en-us_topic_0166889613_p969918109405"><a href="#dcs-api-0312009__en-us_topic_0166889613_table166993107405">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312009__en-us_topic_0166889613_table166993107405"></a><a name="en-us_topic_0166889613_table166993107405"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312009__en-us_topic_0166889613_table166993107405" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312009__en-us_topic_0166889613_row7700310174015"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.2.5.1.1"><p id="dcs-api-0312009__en-us_topic_0166889613_p770012105401">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.2.5.1.2"><p id="dcs-api-0312009__en-us_topic_0166889613_p5700201018409">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.3.2.2.5.1.3"><p id="dcs-api-0312009__en-us_topic_0166889613_p0700210154019">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49%" id="mcps1.3.3.3.2.2.5.1.4"><p id="dcs-api-0312009__en-us_topic_0166889613_p9700610174018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312009__en-us_topic_0166889613_row13700121010407"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312009__en-us_topic_0166889613_p970020103409">instances</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312009__en-us_topic_0166889613_p17631931174018">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.3.2.2.5.1.3 "><p id="dcs-api-0312009__en-us_topic_0166889613_p177632031124010">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312009__en-us_topic_0166889613_p10763173116404">IDs of DCS instances to be deleted.</p>
|
|
<p id="dcs-api-0312009__en-us_topic_0166889613_p142599468162">This parameter is set only when the <strong id="dcs-api-0312009__en-us_topic_0166889613_b16776102555">allFailure</strong> parameter in the URI is set to <strong id="dcs-api-0312009__en-us_topic_0166889613_b13677191065513">false</strong> or another value.</p>
|
|
<p id="dcs-api-0312009__en-us_topic_0166889613_p745592135517">A maximum of 50 instances can be deleted at a time.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="dcs-api-0312009__en-us_topic_0166889613_p15453715101512"><strong id="dcs-api-0312009__en-us_topic_0166889613_b49741426174914">Request URL:</strong></p>
|
|
<pre class="screen" id="dcs-api-0312009__en-us_topic_0166889613_screen156010291318">DELETE https://{dcs_endpoint}/v1.0/{project_id}/instances?allFailure={allFailure}</pre>
|
|
<p id="dcs-api-0312009__en-us_topic_0166889613_p6453215191514">Example request with <strong id="dcs-api-0312009__en-us_topic_0166889613_b1385974312556">allFailure </strong>set to <strong id="dcs-api-0312009__en-us_topic_0166889613_b118599438555">false</strong>:</p>
|
|
<pre class="screen" id="dcs-api-0312009__en-us_topic_0166889613_screen5684399408">{
|
|
"instances": [
|
|
"54602a9d-5e22-4239-9123-77e350df4a34",
|
|
"7166cdea-dbad-4d79-9610-7163e6f8b640"
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312009__en-us_topic_0166889613_section11426254461"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312009__en-us_topic_0166889613_p16935155054116"><strong id="dcs-api-0312009__en-us_topic_0166889613_b1896322582118">Response parameters</strong></p>
|
|
<div class="p" id="dcs-api-0312009__en-us_topic_0166889613_p14935115094112">If the value of the <strong id="dcs-api-0312009__en-us_topic_0166889613_b15115154121917">allFailure</strong> parameter in the URI is <strong id="dcs-api-0312009__en-us_topic_0166889613_b1611504120199">false</strong>, an empty response is then returned. If the value of the <strong id="dcs-api-0312009__en-us_topic_0166889613_b273716175219">allFailure</strong> parameter in the URI is <strong id="dcs-api-0312009__en-us_topic_0166889613_b97375174212">true</strong>, a response containing the parameter in <a href="#dcs-api-0312009__en-us_topic_0166889613_table18935105020414">Table 3</a> is returned.
|
|
<div class="tablenoborder"><a name="dcs-api-0312009__en-us_topic_0166889613_table18935105020414"></a><a name="en-us_topic_0166889613_table18935105020414"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312009__en-us_topic_0166889613_table18935105020414" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312009__en-us_topic_0166889613_row1493665014412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.6.2.4.1.1"><p id="dcs-api-0312009__en-us_topic_0166889613_p193616504419">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.3.6.2.4.1.2"><p id="dcs-api-0312009__en-us_topic_0166889613_p1093625014113">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="66%" id="mcps1.3.4.3.6.2.4.1.3"><p id="dcs-api-0312009__en-us_topic_0166889613_p139361650174115">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312009__en-us_topic_0166889613_row169361650194119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.6.2.4.1.1 "><p id="dcs-api-0312009__en-us_topic_0166889613_p183851432217">results</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.6.2.4.1.2 "><p id="dcs-api-0312009__en-us_topic_0166889613_p10385339215">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.6.2.4.1.3 "><p id="dcs-api-0312009__en-us_topic_0166889613_p1038583526">For details about how to delete an instance, see <a href="#dcs-api-0312009__en-us_topic_0166889613_table69371750154117">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312009__en-us_topic_0166889613_table69371750154117"></a><a name="en-us_topic_0166889613_table69371750154117"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312009__en-us_topic_0166889613_table69371750154117" frame="border" border="1" rules="all"><caption><b>Table 4 </b>results parameter description</caption><thead align="left"><tr id="dcs-api-0312009__en-us_topic_0166889613_row11938155054119"><th align="left" class="cellrowborder" valign="top" width="27.27%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312009__en-us_topic_0166889613_p1693811501414">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.05%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312009__en-us_topic_0166889613_p1493819508416">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.67999999999999%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312009__en-us_topic_0166889613_p3938155084118">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312009__en-us_topic_0166889613_row17938145064112"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312009__en-us_topic_0166889613_p173482043021">instance</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312009__en-us_topic_0166889613_p10348143625">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.67999999999999%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312009__en-us_topic_0166889613_p83483431425">DCS instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312009__en-us_topic_0166889613_row1093895010417"><td class="cellrowborder" valign="top" width="27.27%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312009__en-us_topic_0166889613_p63481043623">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312009__en-us_topic_0166889613_p1348943822">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.67999999999999%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312009__en-us_topic_0166889613_p1934820431025">Instance deletion result. Options: <strong id="dcs-api-0312009__en-us_topic_0166889613_b20263553587">success</strong> and <strong id="dcs-api-0312009__en-us_topic_0166889613_b426335155811">failed</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p class="msonormal" id="dcs-api-0312009__en-us_topic_0166889613_p1830212192316"><strong id="dcs-api-0312009__en-us_topic_0166889613_b17688126162220">Example response</strong></p>
|
|
<pre class="screen" id="dcs-api-0312009__en-us_topic_0166889613_screen206991593217">{
|
|
"results": [
|
|
{
|
|
"instance": "54602a9d-5e22-4239-9123-77e350df4a34",
|
|
"result": "success"
|
|
},
|
|
{
|
|
"instance": "7166cdea-dbad-4d79-9610-7163e6f8b640",
|
|
"result": "success"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312009__en-us_topic_0166889613_section5301161961211"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312009__en-us_topic_0166889613_p3301319121217"><a href="#dcs-api-0312009__en-us_topic_0166889613_table8301101911215">Table 5</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312009__en-us_topic_0166889613_table8301101911215"></a><a name="en-us_topic_0166889613_table8301101911215"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312009__en-us_topic_0166889613_table8301101911215" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dcs-api-0312009__en-us_topic_0166889613_row11302101915124"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312009__en-us_topic_0166889613_p73021519101210">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312009__en-us_topic_0166889613_p830281981219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312009__en-us_topic_0166889613_row16302121941211"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312009__en-us_topic_0166889613_p63027192128">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312009__en-us_topic_0166889613_p1302171916124">DCS instances deleted successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312009__en-us_topic_0166889613_row182271411314"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312009__en-us_topic_0166889613_p168231014739">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312009__en-us_topic_0166889613_p38237146312">DCS instances that failed to be created are cleared successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312003.html">Lifecycle Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|