forked from docs/doc-exports
qiujiandong1
affc0093ff
Reviewed-by: Gergo-Bence Lorincz <a200452876@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
138 lines
9.9 KiB
HTML
138 lines
9.9 KiB
HTML
<a name="DeleteJob"></a><a name="DeleteJob"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Job</h1>
|
|
<div id="body32001227"><div class="section" id="DeleteJob__section9437151815014"><h4 class="sectiontitle">Function</h4><p id="DeleteJob__p194371818175014">This API is used to delete a job in a specified project.</p>
|
|
</div>
|
|
<div class="section" id="DeleteJob__section4437101812503"><h4 class="sectiontitle">URI</h4><p id="DeleteJob__p24371118125010">DELETE /api/v2/projects/{project_id}/jobs/{job_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteJob__table1443818187500" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteJob__row7437518195010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteJob__p1438718115018">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteJob__p74382182505">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteJob__p5438171818506">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteJob__p5438818175017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteJob__row7437818175012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteJob__p443831810507">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteJob__p1943801813502">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteJob__p44381918195017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteJob__p34382181502"><strong id="DeleteJob__b4438718195018">Details</strong>:</p>
|
|
<p id="DeleteJob__p24387181503">Project ID. For details about how to obtain the value, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
|
|
<p id="DeleteJob__p1843891814500"><strong id="DeleteJob__b1943861825016">Constraints</strong>:</p>
|
|
<p id="DeleteJob__p343815189503">None</p>
|
|
<p id="DeleteJob__p243914184504"><strong id="DeleteJob__b543971885010">Options</strong>:</p>
|
|
<p id="DeleteJob__p743941815504">Project IDs of the account</p>
|
|
<p id="DeleteJob__p1743921817503"><strong id="DeleteJob__b7439121865012">Default value</strong>:</p>
|
|
<p id="DeleteJob__p84391218125018">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteJob__row1143781814503"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteJob__p104391918135011">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteJob__p14439201810500">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteJob__p643951865015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteJob__p1243921817506"><strong id="DeleteJob__b7439131819509">Definition</strong></p>
|
|
<p id="DeleteJob__p124393187505">Job ID. For details about how to obtain the value, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
|
|
<p id="DeleteJob__p104397188503"><strong id="DeleteJob__b543921810503">Constraints</strong></p>
|
|
<p id="DeleteJob__p5439121812509">N/A</p>
|
|
<p id="DeleteJob__p44398185506"><strong id="DeleteJob__b343910186500">Range</strong></p>
|
|
<p id="DeleteJob__p11439111885011">N/A</p>
|
|
<p id="DeleteJob__p1043931812506"><strong id="DeleteJob__b3439718155014">Default Value</strong></p>
|
|
<p id="DeleteJob__p13439818125010">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteJob__section10439191835017"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteJob__en-us_topic_0000002484703962_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteJob__row15440818165010"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteJob__p744010180509">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteJob__p174401118115018">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteJob__p1440718125017">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteJob__p74401518195019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteJob__row74401818135011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteJob__p1344091885018">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteJob__p2440101811509">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteJob__p94412018155020">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteJob__p1644120188501"><strong id="DeleteJob__b1744161835015">Details</strong>:</p>
|
|
<p id="DeleteJob__p9441161855012">The request body type or format</p>
|
|
<p id="DeleteJob__p1044191895015"><strong id="DeleteJob__b1944113186509">Constraints</strong>:</p>
|
|
<p id="DeleteJob__p14419185506">The GET method is not verified.</p>
|
|
<p id="DeleteJob__p19441618135011"><strong id="DeleteJob__b194419187505">Options</strong>:</p>
|
|
<ul id="DeleteJob__ul13441218145013"><li id="DeleteJob__li11441201855013"><p id="DeleteJob__p644116184501"><a name="DeleteJob__li11441201855013"></a><a name="li11441201855013"></a>application/json</p>
|
|
</li><li id="DeleteJob__li134414189503"><p id="DeleteJob__p19441518115017"><a name="DeleteJob__li134414189503"></a><a name="li134414189503"></a>application/json;charset=utf-8</p>
|
|
</li><li id="DeleteJob__li144411618175014"><p id="DeleteJob__p844151845016"><a name="DeleteJob__li144411618175014"></a><a name="li144411618175014"></a>application/x-pem-file</p>
|
|
</li><li id="DeleteJob__li1244191810507"><p id="DeleteJob__p34419189502"><a name="DeleteJob__li1244191810507"></a><a name="li1244191810507"></a>multipart/form-data (used when the <strong id="DeleteJob__b10441418195010">FormData</strong> parameter is present)</p>
|
|
</li></ul>
|
|
<p id="DeleteJob__p9441141855020"><strong id="DeleteJob__b12441918145018">Default value</strong>:</p>
|
|
<p id="DeleteJob__p1044111189504">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteJob__row34405181505"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteJob__p204411218185012">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteJob__p184411818135010">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteJob__p1144251805010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteJob__p8442191815018"><strong id="DeleteJob__b44421218185019">Details</strong>:</p>
|
|
<p id="DeleteJob__p14442151813503">Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see <a href="cce_02_0004.html">Obtaining a User Token</a>.</p>
|
|
<p id="DeleteJob__p1944217187502"><strong id="DeleteJob__b1744218189502">Constraints</strong>:</p>
|
|
<p id="DeleteJob__p104421818175020">None</p>
|
|
<p id="DeleteJob__p17442171816507"><strong id="DeleteJob__b1944261811509">Options</strong>:</p>
|
|
<p id="DeleteJob__p84424182507">N/A</p>
|
|
<p id="DeleteJob__p5442171813502"><strong id="DeleteJob__b244212189508">Default value</strong>:</p>
|
|
<p id="DeleteJob__p1344201885017">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteJob__section184423187508"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteJob__p1744215182507"><strong id="DeleteJob__b10442151845013">Status code: 204</strong></p>
|
|
<p id="DeleteJob__p15442118105012">The job has been deleted.</p>
|
|
<p id="DeleteJob__p12442191819509">None</p>
|
|
</div>
|
|
<div class="section" id="DeleteJob__section16442918165014"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteJob__p104422181509">None</p>
|
|
</div>
|
|
<div class="section" id="DeleteJob__section1044217184502"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteJob__p44431018125017">None</p>
|
|
</div>
|
|
<div class="section" id="DeleteJob__section6443161817506"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteJob__en-us_topic_0000002484703962_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteJob__row1744331825016"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteJob__p11443131835017">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteJob__p174431318185013">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteJob__row17443111812501"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteJob__p94431218195016">204</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteJob__p1944311182500">The job has been deleted.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteJob__section164432185506"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteJob__p1644361820504">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="job_lifecycle_management.html">Job Management</a></div>
|
|
</div>
|
|
</div>
|
|
|