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>
103 lines
9.2 KiB
HTML
103 lines
9.2 KiB
HTML
<a name="modelarts_03_0061"></a><a name="modelarts_03_0061"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Training Job Configuration</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0061__en-us_topic_0131292965_section16221625"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0061__en-us_topic_0131292965_p5887182">This API is used to delete a training job configuration.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0061__en-us_topic_0131292965_section11776897"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0061__en-us_topic_0131292965_p111359328415">DELETE /v1/{project_id}/training-job-configs/{config_name}</p>
|
|
<div class="p" id="modelarts_03_0061__en-us_topic_0131292965_p109713251190"><a href="#modelarts_03_0061__en-us_topic_0131292965_table486226859532">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0061__en-us_topic_0131292965_table486226859532"></a><a name="en-us_topic_0131292965_table486226859532"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0061__en-us_topic_0131292965_table486226859532" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="modelarts_03_0061__en-us_topic_0131292965_row175589539532"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0061__en-us_topic_0131292965_p5882069095317">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0061__en-us_topic_0131292965_p6685543195317">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0061__en-us_topic_0131292965_p4658084595317">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_0061__en-us_topic_0131292965_p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0061__en-us_topic_0131292965_row548219009532"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0061__en-us_topic_0131292965_p5473019495317">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0061__en-us_topic_0131292965_p396071495317">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0061__en-us_topic_0131292965_p5238239495317">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_0061__en-us_topic_0131292965_p1511553195317">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_0061__en-us_topic_0131292965_row198702649532"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0061__en-us_topic_0131292965_p5321015895317">config_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0061__en-us_topic_0131292965_p1505556995317">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0061__en-us_topic_0131292965_p1154155695317">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_0061__en-us_topic_0131292965_p6245081595317">Name of a training job configuration</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0061__en-us_topic_0131292965_section38883210"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0061__en-us_topic_0131292965_p1560514112019">None</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0061__en-us_topic_0131292965_section11070993"><h4 class="sectiontitle">Response Body</h4><p id="modelarts_03_0061__en-us_topic_0131292965_p83488516226"><a href="#modelarts_03_0061__en-us_topic_0131292965_table5371703815645">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="modelarts_03_0061__en-us_topic_0131292965_table5371703815645"></a><a name="en-us_topic_0131292965_table5371703815645"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0061__en-us_topic_0131292965_table5371703815645" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="modelarts_03_0061__en-us_topic_0131292965_row740119415645"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="modelarts_03_0061__en-us_topic_0131292965_p5890372115656">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.3.2.4.1.2"><p id="modelarts_03_0061__en-us_topic_0131292965_p5447652915656">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="66%" id="mcps1.3.4.3.2.4.1.3"><p id="modelarts_03_0061__en-us_topic_0131292965_p12966144263911">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0061__en-us_topic_0131292965_row6687143316228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="modelarts_03_0061__en-us_topic_0131292965_p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="modelarts_03_0061__en-us_topic_0131292965_p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="modelarts_03_0061__en-us_topic_0131292965_p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0061__en-us_topic_0131292965_row142758496236"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="modelarts_03_0061__en-us_topic_0131292965_p14275114915230">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="modelarts_03_0061__en-us_topic_0131292965_p9276204919233">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="modelarts_03_0061__en-us_topic_0131292965_p154155962314">Error message of a failed API call.</p>
|
|
<p id="modelarts_03_0061__en-us_topic_0131292965_p1455859112318">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0061__en-us_topic_0131292965_row3990309915645"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="modelarts_03_0061__en-us_topic_0131292965_p5981669415656">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.3.2.4.1.2 "><p id="modelarts_03_0061__en-us_topic_0131292965_p469328915656">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.3.2.4.1.3 "><p id="modelarts_03_0061__en-us_topic_0131292965_p4461216215656">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 class="section" id="modelarts_03_0061__en-us_topic_0131292965_section122768317218"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0061__en-us_topic_0131292965_p179931240122614">The following shows how to delete the job configuration named <span class="parmvalue" id="modelarts_03_0061__en-us_topic_0131292965_parmvalue1879142534520"><b>test-trainconfig</b></span>.</p>
|
|
<ul id="modelarts_03_0061__en-us_topic_0131292965_ul59276915"><li id="modelarts_03_0061__en-us_topic_0131292965_li63730192">Sample request<pre class="screen" id="modelarts_03_0061__en-us_topic_0131292965_screen13001453245">DELETE https://endpoint/v1/{project_id}/training-job-configs/test-trainconfig</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="modelarts_03_0061__en-us_topic_0131292965_ul175231342132119"><li id="modelarts_03_0061__en-us_topic_0131292965_li839501">Successful sample response<pre class="screen" id="modelarts_03_0061__en-us_topic_0131292965_screen89137619514">{
|
|
"is_success": true
|
|
}</pre>
|
|
</li><li id="modelarts_03_0061__en-us_topic_0131292965_li5393724237">Failed sample response<pre class="screen" id="modelarts_03_0061__en-us_topic_0131292965_screen1478311135514">{
|
|
"is_success": false,
|
|
"error_message": "Error string",
|
|
"error_code": "ModelArts.0105"
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="modelarts_03_0061__en-us_topic_0131292965_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0061__en-us_topic_0131292965_p26629305162">For details about the status code, see <a href="modelarts_03_0094.html#modelarts_03_0094__en-us_topic_0132773864_table1450010510213">Table 1</a>.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0061__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0061__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_0057.html">Training Job Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|