vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/modelarts_03_0052.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

127 lines
10 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001909907360"></a><a name="EN-US_TOPIC_0000001909907360"></a>
<h1 class="topictitle1">Modifying the Description of a Training Job</h1>
<div id="body1536890057472"><div class="section" id="EN-US_TOPIC_0000001909907360__section44258583"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909907360__p12375417">This API is used to modify the description of a training job.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907360__section62782929"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909907360__p9842622203117">PUT /v1/{project_id}/training-jobs/{job_id}</p>
<div class="p" id="EN-US_TOPIC_0000001909907360__p026103204011"><a href="#EN-US_TOPIC_0000001909907360__table27718806153710">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907360__table27718806153710"></a><a name="table27718806153710"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907360__table27718806153710" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907360__row5159598153710"><th align="left" class="cellrowborder" valign="top" width="16.66%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909907360__p11997646153731">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.870000000000001%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909907360__p32285308153731">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.459999999999999%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909907360__p64973166153731">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.010000000000005%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909907360__p28335117153731">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907360__row29704788153710"><td class="cellrowborder" valign="top" width="16.66%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907360__p15152240153731">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907360__p19371908153731">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.459999999999999%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907360__p25620709153731">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907360__p62011514153731">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_0000001909907360__row15002706153710"><td class="cellrowborder" valign="top" width="16.66%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907360__p43611234153731">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.870000000000001%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907360__p42849028153731">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.459999999999999%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907360__p48219259153731">Long</p>
</td>
<td class="cellrowborder" valign="top" width="56.010000000000005%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907360__p13445935153731">ID of a training job</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907360__section28175455"><h4 class="sectiontitle">Request Body</h4><div class="p" id="EN-US_TOPIC_0000001909907360__p17810129104519"><a href="#EN-US_TOPIC_0000001909907360__table54779414153816">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907360__table54779414153816"></a><a name="table54779414153816"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907360__table54779414153816" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907360__row43873928153816"><th align="left" class="cellrowborder" valign="top" width="16.41%" id="mcps1.3.3.2.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909907360__p17334755153826">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.950000000000003%" id="mcps1.3.3.2.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909907360__p61937909153826">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.84%" id="mcps1.3.3.2.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909907360__p50914719153826">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.800000000000004%" id="mcps1.3.3.2.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909907360__p30451594153826">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907360__row52319603153816"><td class="cellrowborder" valign="top" width="16.41%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907360__p9824321153826">job_desc</p>
</td>
<td class="cellrowborder" valign="top" width="16.950000000000003%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907360__p57572574153826">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.84%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907360__p32866907153826">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.800000000000004%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907360__p44973792153826">Description of a training job. The value must contain 0 to 256 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907360__section52252504"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000001909907360__p556844974411"><a href="#EN-US_TOPIC_0000001909907360__table10292351155335">Table 3</a> describes the response parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907360__table10292351155335"></a><a name="table10292351155335"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907360__table10292351155335" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907360__row3625826155335"><th align="left" class="cellrowborder" valign="top" width="16.88831116888311%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000001909907360__p30555691155343">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.60873912608739%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000001909907360__p21716303155343">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70.5029497050295%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000001909907360__p14190158155343">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001909907360__row1864417386427"><td class="cellrowborder" valign="top" width="16.88831116888311%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907360__p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="12.60873912608739%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907360__p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="70.5029497050295%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907360__p4130369517407">Whether the request is successful.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907360__row1521113414619"><td class="cellrowborder" valign="top" width="16.88831116888311%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907360__p162114341464">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="12.60873912608739%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907360__p1321183415463">String</p>
</td>
<td class="cellrowborder" valign="top" width="70.5029497050295%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907360__p20221248144610">Error message of a failed API call.</p>
<p id="EN-US_TOPIC_0000001909907360__p152225484461">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001909907360__row47933083155335"><td class="cellrowborder" valign="top" width="16.88831116888311%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907360__p36088361155343">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="12.60873912608739%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907360__p15667417155343">String</p>
</td>
<td class="cellrowborder" valign="top" width="70.5029497050295%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907360__p61101247155343">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_0000001909907360__section3619154784118"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000001909907360__p1420925994217">The following shows how to modify the description of the job whose <span class="parmvalue" id="EN-US_TOPIC_0000001909907360__parmvalue102058566314"><b>job_id</b></span> is <strong id="EN-US_TOPIC_0000001909907360__b8303759520">10</strong>.</p>
<pre class="screen" id="EN-US_TOPIC_0000001909907360__screen2077422415308">PUT https://endpoint/v1/{project_id}/training-jobs/10
{
"job_desc": "This is a ModelArts job"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907360__section11173133553013"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909907360__ul288934310304"><li id="EN-US_TOPIC_0000001909907360__li18891435309">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909907360__screen5889643103017">{
"is_success": true
}</pre>
</li><li id="EN-US_TOPIC_0000001909907360__li788914312303">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909907360__screen4889543173018">{
"is_success": false,
"error_message": "Error string",
"error_code": "ModelArts.0105"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001909907360__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909907360__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>
View Git Blame Copy Permalink