forked from docs/doc-exports
Wuwan, Qi
f81ead2467
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>
102 lines
8.5 KiB
HTML
102 lines
8.5 KiB
HTML
<a name="EN-US_TOPIC_0000001909907472"></a><a name="EN-US_TOPIC_0000001909907472"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Visualization Job</h1>
|
|
<div id="body1536897563953"><div class="section" id="EN-US_TOPIC_0000001909907472__section52877761"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909907472__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="EN-US_TOPIC_0000001909907472__section6137807"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909907472__p487092315135">DELETE /v1/{project_id}/visualization-jobs/{job_id}</p>
|
|
<div class="p" id="EN-US_TOPIC_0000001909907472__p19885194068"><a href="#EN-US_TOPIC_0000001909907472__table20736351173356">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907472__table20736351173356"></a><a name="table20736351173356"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907472__table20736351173356" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907472__row5314023173356"><th align="left" class="cellrowborder" valign="top" width="17.8%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909907472__p10746977173422">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.160000000000002%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909907472__p65198818173422">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.45%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909907472__p46612907173422">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.59%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909907472__p17549157173422">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909907472__row18124941173356"><td class="cellrowborder" valign="top" width="17.8%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907472__p48322763173422">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.160000000000002%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907472__p4813935511624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.45%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907472__p23375442173422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.59%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907472__p14362646173422">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_0000001909907472__row66549402173356"><td class="cellrowborder" valign="top" width="17.8%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909907472__p12481001173422">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.160000000000002%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909907472__p2118234711624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.45%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909907472__p15034621173422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.59%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909907472__p9844788173422">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907472__section55240268"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001909907472__p68295521965">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907472__section27400369"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000001909907472__p285517581068"><a href="#EN-US_TOPIC_0000001909907472__table9370583111247">Table 2</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909907472__table9370583111247"></a><a name="table9370583111247"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909907472__table9370583111247" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909907472__row44247318111247"><th align="left" class="cellrowborder" valign="top" width="18.12%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000001909907472__p6345548711131">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.93%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000001909907472__p5517226111131">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68.95%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000001909907472__p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909907472__row19531920101912"><td class="cellrowborder" valign="top" width="18.12%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907472__p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.93%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907472__p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.95%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907472__p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907472__row14521776111247"><td class="cellrowborder" valign="top" width="18.12%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907472__p2373464311131">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.93%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907472__p3043071611131">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.95%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907472__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_0000001909907472__p4896890711131">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909907472__row50029136111247"><td class="cellrowborder" valign="top" width="18.12%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909907472__p4538668811131">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.93%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909907472__p2003318011131">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.95%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909907472__p1882451014424">Error message of a failed API call.</p>
|
|
<p id="EN-US_TOPIC_0000001909907472__p1207490311131">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_0000001909907472__section5351173113617"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000001909907472__p14559533161">The following shows how to delete the visualization job whose ID is 10.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001909907472__screen52407332517">DELETE https://endpoint/v1/{project_id}/visualization-jobs/10</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909907472__section757017428520"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909907472__ul88811958255"><li id="EN-US_TOPIC_0000001909907472__li088125813520">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909907472__screen7882358053">{
|
|
"is_success": true
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001909907472__li198822588517">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909907472__screen178824581658">{
|
|
"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="EN-US_TOPIC_0000001909907472__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909907472__p135861211131713">For details about the status code, see <a href="modelarts_03_0094.html#EN-US_TOPIC_0000001909907492__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>
|
|
|