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.6 KiB
HTML
102 lines
8.6 KiB
HTML
<a name="EN-US_TOPIC_0000001909747468"></a><a name="EN-US_TOPIC_0000001909747468"></a>
|
|
|
|
<h1 class="topictitle1">Stopping a Visualization Job</h1>
|
|
<div id="body1536897563953"><div class="section" id="EN-US_TOPIC_0000001909747468__section66786352"><h4 class="sectiontitle">Function</h4><p class="MsoNormal" id="EN-US_TOPIC_0000001909747468__p39373866">This API is used to stop 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_0000001909747468__section64206262"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909747468__p587811401412">POST /v1/{project_id}/visualization-jobs/{job_id}/stop</p>
|
|
<div class="p" id="EN-US_TOPIC_0000001909747468__p1065842916716"><a href="#EN-US_TOPIC_0000001909747468__table20736351173356">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747468__table20736351173356"></a><a name="table20736351173356"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747468__table20736351173356" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747468__row5314023173356"><th align="left" class="cellrowborder" valign="top" width="16.17%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909747468__p10746977173422">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.7%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909747468__p65198818173422">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.84%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909747468__p46612907173422">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.28999999999999%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909747468__p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909747468__row18124941173356"><td class="cellrowborder" valign="top" width="16.17%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747468__p48322763173422">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.7%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747468__p4813935511624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.84%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747468__p23375442173422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.28999999999999%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747468__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_0000001909747468__row66549402173356"><td class="cellrowborder" valign="top" width="16.17%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747468__p12481001173422">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.7%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747468__p2118234711624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.84%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747468__p15034621173422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.28999999999999%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747468__p9844788173422">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747468__section40985451"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001909747468__p19477017889">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747468__section33324744"><h4 class="sectiontitle">Response Body</h4><div class="p" id="EN-US_TOPIC_0000001909747468__p14640823584"><a href="#EN-US_TOPIC_0000001909747468__table47616479111324">Table 2</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747468__table47616479111324"></a><a name="table47616479111324"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747468__table47616479111324" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747468__row12629490111324"><th align="left" class="cellrowborder" valign="top" width="16.7016701670167%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0000001909747468__p35449477111334">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.871287128712872%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0000001909747468__p51806285111334">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70.42704270427042%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0000001909747468__p56623322406">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909747468__row1563614243196"><td class="cellrowborder" valign="top" width="16.7016701670167%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747468__p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747468__p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.42704270427042%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747468__p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747468__row44661027111324"><td class="cellrowborder" valign="top" width="16.7016701670167%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747468__p36243623111334">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747468__p27706286111334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.42704270427042%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747468__p156252174210">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_0000001909747468__p29616690111334">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747468__row14605070111324"><td class="cellrowborder" valign="top" width="16.7016701670167%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747468__p46091694111334">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.871287128712872%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747468__p15066853111334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70.42704270427042%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747468__p14926316422">Error message of a failed API call.</p>
|
|
<p id="EN-US_TOPIC_0000001909747468__p12455571111334">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_0000001909747468__section68431056175"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000001909747468__p14591459076">The following shows how to stop the visualization job whose ID is 10.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001909747468__screen1382321216617">POST https://endpoint/v1/{project_id}/visualization-jobs/10/stop </pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747468__section113715241862"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909747468__ul73853332620"><li id="EN-US_TOPIC_0000001909747468__li163854339617">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909747468__screen7385103311615">{
|
|
"is_success": true
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001909747468__li73850330615">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909747468__screen1638543313612">{
|
|
"is_success": false,
|
|
"error_message": "This job can't be stop. job status: 10",
|
|
"error_code": "ModelArts.0105"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747468__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909747468__p1731954913014">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>
|
|
|