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>
104 lines
9.3 KiB
HTML
104 lines
9.3 KiB
HTML
<a name="modelarts_03_0068"></a><a name="modelarts_03_0068"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Visualization Job</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0068__en-us_topic_0131202686_section52877761"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0068__en-us_topic_0131202686_p63062915">This API is used to delete a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in <a href="modelarts_03_0065.html">Querying a Visualization Job List</a> and <a href="modelarts_03_0066.html">Querying the Details About a Visualization Job</a>.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0068__en-us_topic_0131202686_section6137807"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0068__en-us_topic_0131202686_p487092315135">DELETE /v1/{project_id}/visualization-jobs/{job_id}</p>
|
|
<div class="p" id="modelarts_03_0068__en-us_topic_0131202686_p19885194068"><a href="#modelarts_03_0068__en-us_topic_0131202686_table20736351173356">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0068__en-us_topic_0131202686_table20736351173356"></a><a name="en-us_topic_0131202686_table20736351173356"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0068__en-us_topic_0131202686_table20736351173356" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="modelarts_03_0068__en-us_topic_0131202686_row5314023173356"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0068__en-us_topic_0131202686_p10746977173422">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0068__en-us_topic_0131202686_p65198818173422">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0068__en-us_topic_0131202686_p46612907173422">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0068__en-us_topic_0131202686_p17549157173422">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0068__en-us_topic_0131202686_row18124941173356"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0068__en-us_topic_0131202686_p48322763173422">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0068__en-us_topic_0131202686_p4813935511624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0068__en-us_topic_0131202686_p23375442173422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0068__en-us_topic_0131202686_p14362646173422">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_0068__en-us_topic_0131202686_row66549402173356"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0068__en-us_topic_0131202686_p12481001173422">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0068__en-us_topic_0131202686_p2118234711624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0068__en-us_topic_0131202686_p15034621173422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0068__en-us_topic_0131202686_p9844788173422">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0068__en-us_topic_0131202686_section55240268"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0068__en-us_topic_0131202686_p68295521965">None</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0068__en-us_topic_0131202686_section27400369"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0068__en-us_topic_0131202686_p285517581068"><a href="#modelarts_03_0068__en-us_topic_0131202686_table9370583111247">Table 2</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0068__en-us_topic_0131202686_table9370583111247"></a><a name="en-us_topic_0131202686_table9370583111247"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0068__en-us_topic_0131202686_table9370583111247" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="modelarts_03_0068__en-us_topic_0131202686_row44247318111247"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0068__en-us_topic_0131202686_p6345548711131">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.2.2.2.4.1.2"><p id="modelarts_03_0068__en-us_topic_0131202686_p5517226111131">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0068__en-us_topic_0131202686_p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0068__en-us_topic_0131202686_row19531920101912"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0068__en-us_topic_0131202686_p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0068__en-us_topic_0131202686_p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0068__en-us_topic_0131202686_p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0068__en-us_topic_0131202686_row14521776111247"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0068__en-us_topic_0131202686_p2373464311131">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0068__en-us_topic_0131202686_p3043071611131">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0068__en-us_topic_0131202686_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_0068__en-us_topic_0131202686_p4896890711131">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0068__en-us_topic_0131202686_row50029136111247"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0068__en-us_topic_0131202686_p4538668811131">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0068__en-us_topic_0131202686_p2003318011131">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0068__en-us_topic_0131202686_p1882451014424">Error message of a failed API call.</p>
|
|
<p id="modelarts_03_0068__en-us_topic_0131202686_p1207490311131">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0068__en-us_topic_0131202686_section5351173113617"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0068__en-us_topic_0131202686_p14559533161">The following shows how to delete the visualization job whose ID is 10.</p>
|
|
<ul id="modelarts_03_0068__en-us_topic_0131202686_ul43844971"><li id="modelarts_03_0068__en-us_topic_0131202686_li59060423">Sample request<pre class="screen" id="modelarts_03_0068__en-us_topic_0131202686_screen767183514133">DELETE https://endpoint/v1/{project_id}/visualization-jobs/10</pre>
|
|
</li></ul>
|
|
<ul id="modelarts_03_0068__en-us_topic_0131202686_ul8859808"><li id="modelarts_03_0068__en-us_topic_0131202686_li12629409">Successful sample response<pre class="screen" id="modelarts_03_0068__en-us_topic_0131202686_screen122941344151316">{
|
|
"is_success": true
|
|
}</pre>
|
|
</li><li id="modelarts_03_0068__en-us_topic_0131202686_li1264810942710">Failed sample response<pre class="screen" id="modelarts_03_0068__en-us_topic_0131202686_screen15354052121312">{
|
|
"is_success": false,
|
|
"error_message": "This job can't be delete. job status: 9",
|
|
"error_code": "ModelArts.0105"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0068__en-us_topic_0131202686_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0068__en-us_topic_0131202686_p135861211131713">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_0068__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0068__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>
|
|
|