doc-exports/docs/modelarts/api-ref/modelarts_03_0048.html
Wuwan, Qi f81ead2467 ModelArts API 24.3.0 20241128 version
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>
2024-11-29 09:04:54 +00:00

110 lines
9.3 KiB
HTML

<a name="EN-US_TOPIC_0000001909747368"></a><a name="EN-US_TOPIC_0000001909747368"></a>
<h1 class="topictitle1">Deleting a Version of a Training Job</h1>
<div id="body1536890057472"><div class="section" id="EN-US_TOPIC_0000001909747368__section39434663"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909747368__p7144132610476">This API is used to delete a version of a training job.</p>
<p id="EN-US_TOPIC_0000001909747368__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_0000001909747368__section19367652"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909747368__p1058341342112">DELETE /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}</p>
<div class="p" id="EN-US_TOPIC_0000001909747368__p61021538164715"><a href="#EN-US_TOPIC_0000001909747368__table126693715562">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747368__table126693715562"></a><a name="table126693715562"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747368__table126693715562" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747368__row372035415562"><th align="left" class="cellrowborder" valign="top" width="16.648335166483353%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909747368__p17103387155619">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.218378162183782%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909747368__p43197097155619">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.298770122987701%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909747368__p9303972155619">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.83451654834517%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909747368__p15424243155619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909747368__row4678310815562"><td class="cellrowborder" valign="top" width="16.648335166483353%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747368__p65402543155619">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.218378162183782%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747368__p63114603155619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.298770122987701%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747368__p12009244155619">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.83451654834517%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747368__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_0000001909747368__row9926215562"><td class="cellrowborder" valign="top" width="16.648335166483353%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747368__p17972347155619">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.218378162183782%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747368__p46473998155619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.298770122987701%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747368__p6297502155619">Long</p>
</td>
<td class="cellrowborder" valign="top" width="54.83451654834517%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747368__p40335634155619">ID of a training job</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747368__row313214200115"><td class="cellrowborder" valign="top" width="16.648335166483353%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747368__p413313202111">version_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.218378162183782%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747368__p1113442071112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.298770122987701%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747368__p1113402061118">Long</p>
</td>
<td class="cellrowborder" valign="top" width="54.83451654834517%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747368__p9134192081113">Version ID of a training job</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747368__section441563135511"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001909747368__p1560514112019">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747368__section25275946"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000001909747368__p3402925165416"><a href="#EN-US_TOPIC_0000001909747368__table1221422915578">Table 2</a> describes the response parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747368__table1221422915578"></a><a name="table1221422915578"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747368__table1221422915578" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747368__row6616560815578"><th align="left" class="cellrowborder" valign="top" width="16.669999999999998%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000001909747368__p39128198155725">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.809999999999999%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000001909747368__p28702598155725">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70.52000000000001%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000001909747368__p43209091155725">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909747368__row18290165455219"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747368__p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747368__p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="70.52000000000001%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747368__p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747368__row1757872301417"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747368__p1358132391416">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747368__p11581182310140">String</p>
</td>
<td class="cellrowborder" valign="top" width="70.52000000000001%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747368__p202911533131416">Error message of a failed API call.</p>
<p id="EN-US_TOPIC_0000001909747368__p729215339148">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909747368__row4566967315578"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747368__p25254004155725">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="12.809999999999999%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747368__p66849440155725">String</p>
</td>
<td class="cellrowborder" valign="top" width="70.52000000000001%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747368__p46095573155725">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>. 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_0000001909747368__section1383241313551"><h4 class="sectiontitle">Sample Request</h4><pre class="screen" id="EN-US_TOPIC_0000001909747368__screen14147153662611">DELETE https://endpoint/v1/{project_id}/training-jobs/10/versions/10</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747368__section72401414122614"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909747368__ul32613281263"><li id="EN-US_TOPIC_0000001909747368__li42613289262">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909747368__screen11261228172617">{
"is_success": true
}</pre>
</li><li id="EN-US_TOPIC_0000001909747368__li1226152842611">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909747368__screen9273287266">{
"is_success": false,
"error_message": "Error string",
"error_code": "ModelArts.0105"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001909747368__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909747368__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>