forked from docs/doc-exports
525370b67d
ModelArts GA API 06052022 from R&D R&D has provided a right version of ModelArts GA API (06052022) Reviewed-by: Artem Goncharov <Artem.goncharov@gmail.com>
112 lines
10 KiB
HTML
112 lines
10 KiB
HTML
<a name="modelarts_03_0048"></a><a name="modelarts_03_0048"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Version of a Training Job</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0048__en-us_topic_0131151009_section39434663"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0048__en-us_topic_0131151009_p7144132610476">This API is used to delete a version of a training job.</p>
|
|
<p id="modelarts_03_0048__en-us_topic_0131151009_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="modelarts_03_0048__en-us_topic_0131151009_section19367652"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0048__en-us_topic_0131151009_p1058341342112">DELETE /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}</p>
|
|
<div class="p" id="modelarts_03_0048__en-us_topic_0131151009_p61021538164715"><a href="#modelarts_03_0048__en-us_topic_0131151009_table126693715562">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0048__en-us_topic_0131151009_table126693715562"></a><a name="en-us_topic_0131151009_table126693715562"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0048__en-us_topic_0131151009_table126693715562" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="modelarts_03_0048__en-us_topic_0131151009_row372035415562"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0048__en-us_topic_0131151009_p17103387155619">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0048__en-us_topic_0131151009_p43197097155619">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0048__en-us_topic_0131151009_p9303972155619">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0048__en-us_topic_0131151009_p15424243155619">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0048__en-us_topic_0131151009_row4678310815562"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0048__en-us_topic_0131151009_p65402543155619">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0048__en-us_topic_0131151009_p63114603155619">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0048__en-us_topic_0131151009_p12009244155619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0048__en-us_topic_0131151009_p33224746155619">Project ID. For details about how to obtain the project ID, see <a href="modelarts_03_0147.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0048__en-us_topic_0131151009_row9926215562"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0048__en-us_topic_0131151009_p17972347155619">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0048__en-us_topic_0131151009_p46473998155619">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0048__en-us_topic_0131151009_p6297502155619">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0048__en-us_topic_0131151009_p40335634155619">ID of a training job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0048__en-us_topic_0131151009_row313214200115"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0048__en-us_topic_0131151009_p413313202111">version_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0048__en-us_topic_0131151009_p1113442071112">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0048__en-us_topic_0131151009_p1113402061118">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0048__en-us_topic_0131151009_p9134192081113">Version ID of a training job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0048__en-us_topic_0131151009_section441563135511"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0048__en-us_topic_0131151009_p1560514112019">None</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0048__en-us_topic_0131151009_section25275946"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0048__en-us_topic_0131151009_p3402925165416"><a href="#modelarts_03_0048__en-us_topic_0131151009_table1221422915578">Table 2</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0048__en-us_topic_0131151009_table1221422915578"></a><a name="en-us_topic_0131151009_table1221422915578"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0048__en-us_topic_0131151009_table1221422915578" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="modelarts_03_0048__en-us_topic_0131151009_row6616560815578"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0048__en-us_topic_0131151009_p39128198155725">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.4.2.2.2.4.1.2"><p id="modelarts_03_0048__en-us_topic_0131151009_p28702598155725">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="69%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0048__en-us_topic_0131151009_p43209091155725">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0048__en-us_topic_0131151009_row18290165455219"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0048__en-us_topic_0131151009_p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0048__en-us_topic_0131151009_p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0048__en-us_topic_0131151009_p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0048__en-us_topic_0131151009_row1757872301417"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0048__en-us_topic_0131151009_p1358132391416">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0048__en-us_topic_0131151009_p11581182310140">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0048__en-us_topic_0131151009_p202911533131416">Error message of a failed API call.</p>
|
|
<p id="modelarts_03_0048__en-us_topic_0131151009_p729215339148">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0048__en-us_topic_0131151009_row4566967315578"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0048__en-us_topic_0131151009_p25254004155725">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0048__en-us_topic_0131151009_p66849440155725">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0048__en-us_topic_0131151009_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="modelarts_03_0048__en-us_topic_0131151009_section1383241313551"><h4 class="sectiontitle">Samples</h4><ul id="modelarts_03_0048__en-us_topic_0131151009_ul98988458596"><li id="modelarts_03_0048__en-us_topic_0131151009_li14898164525913">Sample request<pre class="screen" id="modelarts_03_0048__en-us_topic_0131151009_screen1666133352116">DELETE https://endpoint/v1/{project_id}/training-jobs/10/versions/10</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="modelarts_03_0048__en-us_topic_0131151009_ul1347242055416"><li id="modelarts_03_0048__en-us_topic_0131151009_li19871320">Successful sample response<pre class="screen" id="modelarts_03_0048__en-us_topic_0131151009_screen17693164062112">{
|
|
"is_success": true
|
|
}</pre>
|
|
</li><li id="modelarts_03_0048__en-us_topic_0131151009_li447432016547">Failed sample response<pre class="screen" id="modelarts_03_0048__en-us_topic_0131151009_screen1115094718218">{
|
|
"is_success": false,
|
|
"error_message": "Error string",
|
|
"error_code": "ModelArts.0105"
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="modelarts_03_0048__en-us_topic_0131151009_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0048__en-us_topic_0131151009_p1731954913014">For details about the status code, see <a href="modelarts_03_0094.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0048__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0048__p1572811255123">See <a href="modelarts_03_0095.html">Error Codes</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>
|
|
|