forked from docs/doc-exports
Wuwan, Qi
f81ead2467
Reviewed-by: Pruthi, Vineet <vineet.pruthi@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>
103 lines
8.7 KiB
HTML
103 lines
8.7 KiB
HTML
<a name="EN-US_TOPIC_0000001909907436"></a><a name="EN-US_TOPIC_0000001909907436"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Training Job</h1>
|
|
<div id="body1536890057472"><div class="section" id="EN-US_TOPIC_0000001909907436__section39434663"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909907436__p19606756104518">This API is used to delete a training job.</p>
|
|
<p id="EN-US_TOPIC_0000001909907436__p130598">Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in <a href="modelarts_03_0046.html">Querying a Training Job List</a> and <a href="modelarts_03_0047.html">Querying the Details About a Training Job Version</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907436__section19367652"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909907436__p4827103673215">DELETE /v1/{project_id}/training-jobs/{job_id}</p>
|
|
<div class="p" id="EN-US_TOPIC_0000001909907436__p1766312020466"><a href="#EN-US_TOPIC_0000001909907436__table126693715562">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907436__table126693715562"></a><a name="table126693715562"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907436__table126693715562" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907436__row372035415562"><th align="left" class="cellrowborder" valign="top" width="17.10828917108289%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909907436__p17103387155619">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.558344165583442%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909907436__p43197097155619">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.64873512648735%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909907436__p9303972155619">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.68463153684632%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909907436__p15424243155619">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909907436__row4678310815562"><td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907436__p65402543155619">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.558344165583442%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907436__p63114603155619">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.64873512648735%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907436__p12009244155619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.68463153684632%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907436__p33224746155619">Project ID. For details about how to obtain a project ID, see <a href="modelarts_03_0147.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907436__row9926215562"><td class="cellrowborder" valign="top" width="17.10828917108289%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907436__p17972347155619">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.558344165583442%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907436__p46473998155619">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.64873512648735%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907436__p6297502155619">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.68463153684632%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907436__p40335634155619">ID of a training job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907436__section441563135511"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001909907436__p1560514112019">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907436__section25275946"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000001909907436__p11113193715470"><a href="#EN-US_TOPIC_0000001909907436__table1221422915578">Table 2</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907436__table1221422915578"></a><a name="table1221422915578"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907436__table1221422915578" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907436__row6616560815578"><th align="left" class="cellrowborder" valign="top" width="17.02%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000001909907436__p39128198155725">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.97%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000001909907436__p28702598155725">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70.00999999999999%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000001909907436__p43209091155725">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909907436__row69607214488"><td class="cellrowborder" valign="top" width="17.02%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907436__p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.97%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907436__p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.00999999999999%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907436__p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907436__row1757872301417"><td class="cellrowborder" valign="top" width="17.02%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907436__p1358132391416">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.97%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907436__p11581182310140">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.00999999999999%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907436__p202911533131416">Error message of a failed API call.</p>
|
|
<p id="EN-US_TOPIC_0000001909907436__p729215339148">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907436__row4566967315578"><td class="cellrowborder" valign="top" width="17.02%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907436__p25254004155725">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.97%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907436__p66849440155725">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.00999999999999%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907436__p46095573155725">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
<p id="EN-US_TOPIC_0000001909907436__p42753918155725">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907436__section9327566474"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000001909907436__p731910175491">The following shows how to delete the job whose <span class="parmvalue" id="EN-US_TOPIC_0000001909907436__parmvalue1462020115332"><b>job_id</b></span> is <strong id="EN-US_TOPIC_0000001909907436__b191492445314">10</strong>.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001909907436__screen412855443015">DELETE https://endpoint/v1/{project_id}/training-jobs/10</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907436__section856317163118"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909907436__ul1086719913117"><li id="EN-US_TOPIC_0000001909907436__li1886719913113">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909907436__screen16867209173114">{
|
|
"is_success": true
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001909907436__li986729193117">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909907436__screen486719123111">{
|
|
"is_success": false,
|
|
"error_message": "Error string",
|
|
"error_code": "ModelArts.0105"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907436__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909907436__p1731954913014">For details about the status code, see <a href="modelarts_03_0094.html">Status Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_03_0044.html">Training Jobs</a></div>
|
|
</div>
|
|
</div>
|
|
|