yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
0b3a43371a4bcc99577594de0a685249d676a567
doc-exports/docs/modelarts/api-ref/modelarts_03_0067.html
Wuwan, Qi 78d5ebfce8 ModelArts API 25.3.0 20250710 
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>
2025-07-28 12:24:54 +00:00

128 lines
10 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002340898774"></a><a name="EN-US_TOPIC_0000002340898774"></a>
<h1 class="topictitle1">Modifying the Description of a Visualization Job</h1>
<div id="body1536897563953"><div class="section" id="EN-US_TOPIC_0000002340898774__section54268524"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002340898774__p49860368">This API is used to modify the description of a visualization job.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898774__section18654671"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002340898774__p1171011619124">PUT /v1/{project_id}/visualization-jobs/{job_id}</p>
<div class="p" id="EN-US_TOPIC_0000002340898774__p121181831145"><a href="#EN-US_TOPIC_0000002340898774__table4247299117445">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002340898774__table4247299117445"></a><a name="table4247299117445"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340898774__table4247299117445" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340898774__row4721957617445"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000002340898774__p248161331751">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.82%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000002340898774__p639497501751">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.91%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000002340898774__p125472271751">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.93%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000002340898774__p23681614151847">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898774__row5246075817445"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002340898774__p400366291751">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002340898774__p4813935511624">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.91%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002340898774__p162336961751">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.93%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002340898774__p398610001751">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_0000002340898774__row1984744817333"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002340898774__p44905214173316">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.82%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002340898774__p2118234711624">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.91%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002340898774__p15197337173316">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.93%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002340898774__p23024745173316">ID of a visualization job</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898774__section33674314"><h4 class="sectiontitle">Request Body</h4><div class="p" id="EN-US_TOPIC_0000002340898774__p2034214311515"><a href="#EN-US_TOPIC_0000002340898774__table212731411827">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002340898774__table212731411827"></a><a name="table212731411827"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340898774__table212731411827" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340898774__row6254452211827"><th align="left" class="cellrowborder" valign="top" width="18.12%" id="mcps1.3.3.2.2.2.5.1.1"><p id="EN-US_TOPIC_0000002340898774__p4689069211844">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.3.2.2.2.5.1.2"><p id="EN-US_TOPIC_0000002340898774__p4004974111844">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.839999999999998%" id="mcps1.3.3.2.2.2.5.1.3"><p id="EN-US_TOPIC_0000002340898774__p2280359411844">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.89000000000001%" id="mcps1.3.3.2.2.2.5.1.4"><p id="EN-US_TOPIC_0000002340898774__p54951621164019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898774__row2838111311827"><td class="cellrowborder" valign="top" width="18.12%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002340898774__p4519425311844">job_desc</p>
</td>
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002340898774__p3685585211844">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.839999999999998%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002340898774__p3253402411844">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.89000000000001%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002340898774__p1801024811844">Description of a visualization job. The value must contain 0 to 256 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898774__section34633374"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000002340898774__p16301623254"><a href="#EN-US_TOPIC_0000002340898774__table33036183111023">Table 3</a> describes the response parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000002340898774__table33036183111023"></a><a name="table33036183111023"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002340898774__table33036183111023" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002340898774__row15289441111023"><th align="left" class="cellrowborder" valign="top" width="16.27%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000002340898774__p55035487111034">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.67%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000002340898774__p42143642111034">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="71.06%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000002340898774__p2231724154010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002340898774__row14335710151914"><td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898774__p2530905217407">is_success</p>
</td>
<td class="cellrowborder" valign="top" width="12.67%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898774__p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="71.06%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898774__p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002340898774__row60389753111023"><td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898774__p60647761111034">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="12.67%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898774__p21507328111034">String</p>
</td>
<td class="cellrowborder" valign="top" width="71.06%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898774__p6794189104212">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
<p id="EN-US_TOPIC_0000002340898774__p4896890711131">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002340898774__row42003722111023"><td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000002340898774__p54888684111034">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="12.67%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000002340898774__p18497151111034">String</p>
</td>
<td class="cellrowborder" valign="top" width="71.06%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000002340898774__p7648731154213">Error message of a failed API call.</p>
<p id="EN-US_TOPIC_0000002340898774__p21874237111034">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_0000002340898774__section12376840748"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000002340898774__p20732194110416">The following shows how to modify the description of the visualization job whose ID is <strong id="EN-US_TOPIC_0000002340898774__b32392167457">10</strong> to <strong id="EN-US_TOPIC_0000002340898774__b62451116174511">This is a ModelArts job</strong>.</p>
<pre class="screen" id="EN-US_TOPIC_0000002340898774__screen77225301842">PUT https://endpoint/v1/{project_id}/visualization-jobs/10
{
"job_desc": "This is a ModelArts job"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898774__section518819529416"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000002340898774__ul101173164514"><li id="EN-US_TOPIC_0000002340898774__li17117516055">Successful response<pre class="screen" id="EN-US_TOPIC_0000002340898774__screen191174165510">{
"is_success": true
}</pre>
</li><li id="EN-US_TOPIC_0000002340898774__li1911771615519">Failed response<pre class="screen" id="EN-US_TOPIC_0000002340898774__screen1111719161657">{
"is_success": false,
"error_message": "Illegal name: %%123",
"error_code": "ModelArts.0104"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000002340898774__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000002340898774__p10169164179">For details about the status code, see <a href="modelarts_03_0094.html#EN-US_TOPIC_0000002374856625__table1450010510213">Table 1</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="modelarts_03_0063.html">Visualization Jobs</a></div>
</div>
</div>
View Git Blame Copy Permalink