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>
129 lines
12 KiB
HTML
129 lines
12 KiB
HTML
<a name="modelarts_03_0052"></a><a name="modelarts_03_0052"></a>
|
|
|
|
<h1 class="topictitle1">Modifying the Description of a Training Job</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0052__en-us_topic_0131151011_section44258583"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0052__en-us_topic_0131151011_p12375417">This API is used to modify the description of a training job.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0052__en-us_topic_0131151011_section62782929"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0052__en-us_topic_0131151011_p9842622203117">PUT /v1/{project_id}/training-jobs/{job_id}</p>
|
|
<div class="p" id="modelarts_03_0052__en-us_topic_0131151011_p026103204011"><a href="#modelarts_03_0052__en-us_topic_0131151011_table27718806153710">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0052__en-us_topic_0131151011_table27718806153710"></a><a name="en-us_topic_0131151011_table27718806153710"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0052__en-us_topic_0131151011_table27718806153710" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0052__en-us_topic_0131151011_row5159598153710"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0052__en-us_topic_0131151011_p11997646153731">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_0052__en-us_topic_0131151011_p32285308153731">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_0052__en-us_topic_0131151011_p64973166153731">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0052__en-us_topic_0131151011_p28335117153731">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0052__en-us_topic_0131151011_row29704788153710"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0052__en-us_topic_0131151011_p15152240153731">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_0052__en-us_topic_0131151011_p19371908153731">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0052__en-us_topic_0131151011_p25620709153731">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0052__en-us_topic_0131151011_p62011514153731">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_0052__en-us_topic_0131151011_row15002706153710"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0052__en-us_topic_0131151011_p43611234153731">job_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_0052__en-us_topic_0131151011_p42849028153731">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0052__en-us_topic_0131151011_p48219259153731">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0052__en-us_topic_0131151011_p13445935153731">ID of a training job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0052__en-us_topic_0131151011_section28175455"><h4 class="sectiontitle">Request Body</h4><div class="p" id="modelarts_03_0052__en-us_topic_0131151011_p17810129104519"><a href="#modelarts_03_0052__en-us_topic_0131151011_table54779414153816">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0052__en-us_topic_0131151011_table54779414153816"></a><a name="en-us_topic_0131151011_table54779414153816"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0052__en-us_topic_0131151011_table54779414153816" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0052__en-us_topic_0131151011_row43873928153816"><th align="left" class="cellrowborder" valign="top" width="17.821782178217823%" id="mcps1.3.3.2.2.2.5.1.1"><p id="modelarts_03_0052__en-us_topic_0131151011_p17334755153826">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.851485148514854%" id="mcps1.3.3.2.2.2.5.1.2"><p id="modelarts_03_0052__en-us_topic_0131151011_p61937909153826">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.891089108910894%" id="mcps1.3.3.2.2.2.5.1.3"><p id="modelarts_03_0052__en-us_topic_0131151011_p50914719153826">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.43564356435644%" id="mcps1.3.3.2.2.2.5.1.4"><p id="modelarts_03_0052__en-us_topic_0131151011_p30451594153826">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0052__en-us_topic_0131151011_row52319603153816"><td class="cellrowborder" valign="top" width="17.821782178217823%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0052__en-us_topic_0131151011_p9824321153826">job_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.851485148514854%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0052__en-us_topic_0131151011_p57572574153826">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.891089108910894%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0052__en-us_topic_0131151011_p32866907153826">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.43564356435644%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0052__en-us_topic_0131151011_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="modelarts_03_0052__en-us_topic_0131151011_section52252504"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0052__en-us_topic_0131151011_p556844974411"><a href="#modelarts_03_0052__en-us_topic_0131151011_table10292351155335">Table 3</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0052__en-us_topic_0131151011_table10292351155335"></a><a name="en-us_topic_0131151011_table10292351155335"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0052__en-us_topic_0131151011_table10292351155335" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0052__en-us_topic_0131151011_row3625826155335"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0052__en-us_topic_0131151011_p30555691155343">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.4.2.2.2.4.1.2"><p id="modelarts_03_0052__en-us_topic_0131151011_p21716303155343">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0052__en-us_topic_0131151011_p14190158155343">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0052__en-us_topic_0131151011_row1864417386427"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0052__en-us_topic_0131151011_p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0052__en-us_topic_0131151011_p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0052__en-us_topic_0131151011_p4130369517407">Whether the request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0052__en-us_topic_0131151011_row1521113414619"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0052__en-us_topic_0131151011_p162114341464">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0052__en-us_topic_0131151011_p1321183415463">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0052__en-us_topic_0131151011_p20221248144610">Error message of a failed API call.</p>
|
|
<p id="modelarts_03_0052__en-us_topic_0131151011_p152225484461">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0052__en-us_topic_0131151011_row47933083155335"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0052__en-us_topic_0131151011_p36088361155343">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0052__en-us_topic_0131151011_p15667417155343">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0052__en-us_topic_0131151011_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="modelarts_03_0052__en-us_topic_0131151011_section3619154784118"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0052__en-us_topic_0131151011_p1420925994217">The following shows how to modify the description of the job whose <span class="parmvalue" id="modelarts_03_0052__en-us_topic_0131151011_parmvalue102058566314"><b>job_id</b></span> is <strong id="modelarts_03_0052__en-us_topic_0131151011_b8303759520">10</strong>.</p>
|
|
<ul id="modelarts_03_0052__en-us_topic_0131151011_ul113206507416"><li id="modelarts_03_0052__en-us_topic_0131151011_li38799007">Sample request<pre class="screen" id="modelarts_03_0052__en-us_topic_0131151011_screen1671125911314">PUT https://endpoint/v1/{project_id}/training-jobs/10
|
|
{
|
|
"job_desc": "This is a ModelArts job"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="modelarts_03_0052__en-us_topic_0131151011_ul58483765"><li id="modelarts_03_0052__en-us_topic_0131151011_li56591841">Successful sample response<pre class="screen" id="modelarts_03_0052__en-us_topic_0131151011_screen1097811816329">{
|
|
"is_success": true
|
|
}</pre>
|
|
</li><li id="modelarts_03_0052__en-us_topic_0131151011_li9256651151510">Failed sample response<pre class="screen" id="modelarts_03_0052__en-us_topic_0131151011_screen7378127113218">{
|
|
"is_success": false,
|
|
"error_message": "Error string",
|
|
"error_code": "ModelArts.0105"
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="modelarts_03_0052__en-us_topic_0131151011_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0052__en-us_topic_0131151011_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_0052__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0052__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>
|
|
|