youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/modelarts/api-ref/modelarts_03_0067.html
Beibei 525370b67d
ModelArts GA API 06052022 from R&D (#14) 
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>
2022-05-23 16:26:34 +00:00

130 lines
12 KiB
HTML
Raw Blame History

<a name="modelarts_03_0067"></a><a name="modelarts_03_0067"></a>
<h1 class="topictitle1">Modifying the Description of a Visualization Job</h1>
<div id="body8662426"><div class="section" id="modelarts_03_0067__en-us_topic_0131202685_section54268524"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0067__en-us_topic_0131202685_p49860368">This API is used to modify the description of a visualization job.</p>
</div>
<div class="section" id="modelarts_03_0067__en-us_topic_0131202685_section18654671"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0067__en-us_topic_0131202685_p1171011619124">PUT /v1/{project_id}/visualization-jobs/{job_id}</p>
<div class="p" id="modelarts_03_0067__en-us_topic_0131202685_p121181831145"><a href="#modelarts_03_0067__en-us_topic_0131202685_table4247299117445">Table 1</a> describes the required parameters.
<div class="tablenoborder"><a name="modelarts_03_0067__en-us_topic_0131202685_table4247299117445"></a><a name="en-us_topic_0131202685_table4247299117445"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0067__en-us_topic_0131202685_table4247299117445" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0067__en-us_topic_0131202685_row4721957617445"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0067__en-us_topic_0131202685_p248161331751">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0067__en-us_topic_0131202685_p639497501751">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0067__en-us_topic_0131202685_p125472271751">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0067__en-us_topic_0131202685_p23681614151847">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0067__en-us_topic_0131202685_row5246075817445"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0067__en-us_topic_0131202685_p400366291751">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0067__en-us_topic_0131202685_p4813935511624">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0067__en-us_topic_0131202685_p162336961751">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0067__en-us_topic_0131202685_p398610001751">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_0067__en-us_topic_0131202685_row1984744817333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0067__en-us_topic_0131202685_p44905214173316">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0067__en-us_topic_0131202685_p2118234711624">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0067__en-us_topic_0131202685_p15197337173316">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0067__en-us_topic_0131202685_p23024745173316">ID of a visualization job</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="modelarts_03_0067__en-us_topic_0131202685_section33674314"><h4 class="sectiontitle">Request Body</h4><div class="p" id="modelarts_03_0067__en-us_topic_0131202685_p2034214311515"><a href="#modelarts_03_0067__en-us_topic_0131202685_table212731411827">Table 2</a> describes the request parameters.
<div class="tablenoborder"><a name="modelarts_03_0067__en-us_topic_0131202685_table212731411827"></a><a name="en-us_topic_0131202685_table212731411827"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0067__en-us_topic_0131202685_table212731411827" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0067__en-us_topic_0131202685_row6254452211827"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.3.2.2.2.5.1.1"><p id="modelarts_03_0067__en-us_topic_0131202685_p4689069211844">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.3.2.2.2.5.1.2"><p id="modelarts_03_0067__en-us_topic_0131202685_p4004974111844">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.121212121212121%" id="mcps1.3.3.2.2.2.5.1.3"><p id="modelarts_03_0067__en-us_topic_0131202685_p2280359411844">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.505050505050505%" id="mcps1.3.3.2.2.2.5.1.4"><p id="modelarts_03_0067__en-us_topic_0131202685_p54951621164019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0067__en-us_topic_0131202685_row2838111311827"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.2.2.2.5.1.1 "><p id="modelarts_03_0067__en-us_topic_0131202685_p4519425311844">job_desc</p>
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.2.2.5.1.2 "><p id="modelarts_03_0067__en-us_topic_0131202685_p3685585211844">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.3.2.2.2.5.1.3 "><p id="modelarts_03_0067__en-us_topic_0131202685_p3253402411844">String</p>
</td>
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.3.2.2.2.5.1.4 "><p id="modelarts_03_0067__en-us_topic_0131202685_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="modelarts_03_0067__en-us_topic_0131202685_section34633374"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0067__en-us_topic_0131202685_p16301623254"><a href="#modelarts_03_0067__en-us_topic_0131202685_table33036183111023">Table 3</a> describes the response parameters.
<div class="tablenoborder"><a name="modelarts_03_0067__en-us_topic_0131202685_table33036183111023"></a><a name="en-us_topic_0131202685_table33036183111023"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0067__en-us_topic_0131202685_table33036183111023" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0067__en-us_topic_0131202685_row15289441111023"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0067__en-us_topic_0131202685_p55035487111034">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_0067__en-us_topic_0131202685_p42143642111034">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0067__en-us_topic_0131202685_p2231724154010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="modelarts_03_0067__en-us_topic_0131202685_row14335710151914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0067__en-us_topic_0131202685_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_0067__en-us_topic_0131202685_p2536505617407">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0067__en-us_topic_0131202685_p4130369517407">Whether the request is successful</p>
</td>
</tr>
<tr id="modelarts_03_0067__en-us_topic_0131202685_row60389753111023"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0067__en-us_topic_0131202685_p60647761111034">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_0067__en-us_topic_0131202685_p21507328111034">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0067__en-us_topic_0131202685_p6794189104212">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
<p id="modelarts_03_0067__en-us_topic_0131202685_p4896890711131">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
<tr id="modelarts_03_0067__en-us_topic_0131202685_row42003722111023"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0067__en-us_topic_0131202685_p54888684111034">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_0067__en-us_topic_0131202685_p18497151111034">String</p>
</td>
<td class="cellrowborder" valign="top" width="66%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0067__en-us_topic_0131202685_p7648731154213">Error message of a failed API call.</p>
<p id="modelarts_03_0067__en-us_topic_0131202685_p21874237111034">This parameter is not included when the API call succeeds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="modelarts_03_0067__en-us_topic_0131202685_section12376840748"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0067__en-us_topic_0131202685_p20732194110416">The following shows how to modify the description of the visualization job whose ID is <strong id="modelarts_03_0067__en-us_topic_0131202685_b32392167457">10</strong> to <strong id="modelarts_03_0067__en-us_topic_0131202685_b62451116174511">This is a ModelArts job</strong>.</p>
<ul id="modelarts_03_0067__en-us_topic_0131202685_ul1364915511641"><li id="modelarts_03_0067__en-us_topic_0131202685_li23934202">Sample request<pre class="screen" id="modelarts_03_0067__en-us_topic_0131202685_screen1476317325122">PUT https://endpoint/v1/{project_id}/visualization-jobs/10
{
"job_desc": "This is a ModelArts job"
}</pre>
</li></ul>
<ul id="modelarts_03_0067__en-us_topic_0131202685_ul1094319571347"><li id="modelarts_03_0067__en-us_topic_0131202685_li5077889">Successful sample response<pre class="screen" id="modelarts_03_0067__en-us_topic_0131202685_screen1434516407123">{
"is_success": true
}</pre>
</li><li id="modelarts_03_0067__en-us_topic_0131202685_li162254330265">Failed sample response<pre class="screen" id="modelarts_03_0067__en-us_topic_0131202685_screen152010475127">{
"is_success": false,
"error_message": "Illegal name: %%123",
"error_code": "ModelArts.0104"
}</pre>
</li></ul>
</div>
<div class="section" id="modelarts_03_0067__en-us_topic_0131202685_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0067__en-us_topic_0131202685_p10169164179">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_0067__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0067__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_0063.html">Visualization Jobs</a></div>
</div>
</div>
View Git Blame Copy Permalink