doc-exports/docs/modelarts/api-ref/modelarts_03_0061.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

102 lines
8.5 KiB
HTML

<a name="EN-US_TOPIC_0000001909907500"></a><a name="EN-US_TOPIC_0000001909907500"></a>
<h1 class="topictitle1">Deleting a Training Job Configuration</h1>
<div id="body1536915643272"><div class="section" id="EN-US_TOPIC_0000001909907500__section16221625"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909907500__p5887182">This API is used to delete a training job configuration.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907500__section11776897"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909907500__p111359328415">DELETE /v1/{project_id}/training-job-configs/{config_name}</p>
<div class="p" id="EN-US_TOPIC_0000001909907500__p109713251190"><a href="#EN-US_TOPIC_0000001909907500__table486226859532">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907500__table486226859532"></a><a name="table486226859532"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907500__table486226859532" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907500__row175589539532"><th align="left" class="cellrowborder" valign="top" width="17.49%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909907500__p5882069095317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.73%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909907500__p6685543195317">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.979999999999999%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909907500__p4658084595317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.800000000000004%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909907500__p23681614151847">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907500__row548219009532"><td class="cellrowborder" valign="top" width="17.49%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907500__p5473019495317">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907500__p396071495317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907500__p5238239495317">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.800000000000004%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907500__p1511553195317">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_0000001909907500__row198702649532"><td class="cellrowborder" valign="top" width="17.49%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907500__p5321015895317">config_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907500__p1505556995317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="10.979999999999999%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907500__p1154155695317">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.800000000000004%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907500__p6245081595317">Name of a training job configuration</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907500__section38883210"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001909907500__p1560514112019">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907500__section11070993"><h4 class="sectiontitle">Response Body</h4><p id="EN-US_TOPIC_0000001909907500__p83488516226"><a href="#EN-US_TOPIC_0000001909907500__table5371703815645">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907500__table5371703815645"></a><a name="table5371703815645"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907500__table5371703815645" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907500__row740119415645"><th align="left" class="cellrowborder" valign="top" width="18.47815218478152%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001909907500__p5890372115656">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.598740125987401%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001909907500__p5447652915656">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="68.92310768923107%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001909907500__p12966144263911">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907500__row6687143316228"><td class="cellrowborder" valign="top" width="18.47815218478152%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907500__p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="12.598740125987401%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907500__p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="68.92310768923107%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907500__p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907500__row142758496236"><td class="cellrowborder" valign="top" width="18.47815218478152%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907500__p14275114915230">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="12.598740125987401%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907500__p9276204919233">String</p>
</td>
<td class="cellrowborder" valign="top" width="68.92310768923107%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907500__p154155962314">Error message of a failed API call.</p>
<p id="EN-US_TOPIC_0000001909907500__p1455859112318">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907500__row3990309915645"><td class="cellrowborder" valign="top" width="18.47815218478152%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907500__p5981669415656">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="12.598740125987401%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907500__p469328915656">String</p>
</td>
<td class="cellrowborder" valign="top" width="68.92310768923107%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907500__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="EN-US_TOPIC_0000001909907500__section122768317218"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000001909907500__p179931240122614">The following shows how to delete the job configuration named <span class="parmvalue" id="EN-US_TOPIC_0000001909907500__parmvalue1879142534520"><b>test-trainconfig</b></span>.</p>
<div class="p" id="EN-US_TOPIC_0000001909907500__p1025518361010"><pre class="screen" id="EN-US_TOPIC_0000001909907500__screen2022414452438">DELETE https://endpoint/v1/{project_id}/training-job-configs/test-trainconfig</pre>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907500__section5502144218013"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909907500__ul1232615114012"><li id="EN-US_TOPIC_0000001909907500__li032611511202">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909907500__screen1132675114017">{
"is_success": true
}</pre>
</li><li id="EN-US_TOPIC_0000001909907500__li23261151409">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909907500__screen232615515014">{
"is_success": false,
"error_message": "Error string",
"error_code": "ModelArts.0105"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907500__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909907500__p26629305162">For details about the status code, see <a href="modelarts_03_0094.html#EN-US_TOPIC_0000001909907492__table1450010510213">Table 1</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>