forked from laiweijian4/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.7 KiB
HTML
104 lines
9.7 KiB
HTML
<a name="modelarts_03_0069"></a><a name="modelarts_03_0069"></a>
|
|
|
|
<h1 class="topictitle1">Stopping a Visualization Job</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0069__en-us_topic_0131202687_section66786352"><h4 class="sectiontitle">Function</h4><p class="MsoNormal" id="modelarts_03_0069__en-us_topic_0131202687_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="modelarts_03_0069__en-us_topic_0131202687_section64206262"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0069__en-us_topic_0131202687_p587811401412">POST /v1/{project_id}/visualization-jobs/{job_id}/stop</p>
|
|
<div class="p" id="modelarts_03_0069__en-us_topic_0131202687_p1065842916716"><a href="#modelarts_03_0069__en-us_topic_0131202687_table20736351173356">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0069__en-us_topic_0131202687_table20736351173356"></a><a name="en-us_topic_0131202687_table20736351173356"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0069__en-us_topic_0131202687_table20736351173356" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="modelarts_03_0069__en-us_topic_0131202687_row5314023173356"><th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.2.3.2.2.5.1.1"><p id="modelarts_03_0069__en-us_topic_0131202687_p10746977173422">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.141414141414144%" id="mcps1.3.2.3.2.2.5.1.2"><p id="modelarts_03_0069__en-us_topic_0131202687_p65198818173422">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.111111111111112%" id="mcps1.3.2.3.2.2.5.1.3"><p id="modelarts_03_0069__en-us_topic_0131202687_p46612907173422">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.57575757575757%" id="mcps1.3.2.3.2.2.5.1.4"><p id="modelarts_03_0069__en-us_topic_0131202687_p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0069__en-us_topic_0131202687_row18124941173356"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0069__en-us_topic_0131202687_p48322763173422">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0069__en-us_topic_0131202687_p4813935511624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.111111111111112%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0069__en-us_topic_0131202687_p23375442173422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0069__en-us_topic_0131202687_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_0069__en-us_topic_0131202687_row66549402173356"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="modelarts_03_0069__en-us_topic_0131202687_p12481001173422">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="modelarts_03_0069__en-us_topic_0131202687_p2118234711624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.111111111111112%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="modelarts_03_0069__en-us_topic_0131202687_p15034621173422">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="modelarts_03_0069__en-us_topic_0131202687_p9844788173422">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0069__en-us_topic_0131202687_section40985451"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0069__en-us_topic_0131202687_p19477017889">None</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0069__en-us_topic_0131202687_section33324744"><h4 class="sectiontitle">Response Body</h4><div class="p" id="modelarts_03_0069__en-us_topic_0131202687_p14640823584"><a href="#modelarts_03_0069__en-us_topic_0131202687_table47616479111324">Table 2</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0069__en-us_topic_0131202687_table47616479111324"></a><a name="en-us_topic_0131202687_table47616479111324"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0069__en-us_topic_0131202687_table47616479111324" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="modelarts_03_0069__en-us_topic_0131202687_row12629490111324"><th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.2.2.2.4.1.1"><p id="modelarts_03_0069__en-us_topic_0131202687_p35449477111334">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.111111111111112%" id="mcps1.3.4.2.2.2.4.1.2"><p id="modelarts_03_0069__en-us_topic_0131202687_p51806285111334">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="71.71717171717171%" id="mcps1.3.4.2.2.2.4.1.3"><p id="modelarts_03_0069__en-us_topic_0131202687_p56623322406">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0069__en-us_topic_0131202687_row1563614243196"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0069__en-us_topic_0131202687_p2530905217407">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.111111111111112%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0069__en-us_topic_0131202687_p2536505617407">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="71.71717171717171%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0069__en-us_topic_0131202687_p4130369517407">Whether the request is successful</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0069__en-us_topic_0131202687_row44661027111324"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0069__en-us_topic_0131202687_p36243623111334">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.111111111111112%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0069__en-us_topic_0131202687_p27706286111334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="71.71717171717171%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0069__en-us_topic_0131202687_p156252174210">Error code of a failed API call. For details, see <a href="modelarts_03_0095.html">Error Codes</a>.</p>
|
|
<p id="modelarts_03_0069__en-us_topic_0131202687_p29616690111334">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0069__en-us_topic_0131202687_row14605070111324"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="modelarts_03_0069__en-us_topic_0131202687_p46091694111334">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.111111111111112%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="modelarts_03_0069__en-us_topic_0131202687_p15066853111334">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="71.71717171717171%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="modelarts_03_0069__en-us_topic_0131202687_p14926316422">Error message of a failed API call.</p>
|
|
<p id="modelarts_03_0069__en-us_topic_0131202687_p12455571111334">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0069__en-us_topic_0131202687_section68431056175"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0069__en-us_topic_0131202687_p14591459076">The following shows how to stop the visualization job whose ID is 10.</p>
|
|
<ul id="modelarts_03_0069__en-us_topic_0131202687_ul9339906"><li id="modelarts_03_0069__en-us_topic_0131202687_li16950294">Sample request<pre class="screen" id="modelarts_03_0069__en-us_topic_0131202687_screen15427191416144">POST https://endpoint/v1/{project_id}/visualization-jobs/10/stop </pre>
|
|
</li></ul>
|
|
<ul id="modelarts_03_0069__en-us_topic_0131202687_ul11496527"><li id="modelarts_03_0069__en-us_topic_0131202687_li36359880">Successful sample response<pre class="screen" id="modelarts_03_0069__en-us_topic_0131202687_screen3645142418143">{
|
|
"is_success": true
|
|
}</pre>
|
|
</li><li id="modelarts_03_0069__en-us_topic_0131202687_li6873174614279">Failed sample response<pre class="screen" id="modelarts_03_0069__en-us_topic_0131202687_screen16201144041411">{
|
|
"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="modelarts_03_0069__en-us_topic_0131202687_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0069__en-us_topic_0131202687_p1731954913014">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_0069__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0069__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>
|
|
|