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>
170 lines
14 KiB
HTML
170 lines
14 KiB
HTML
<a name="modelarts_03_0066"></a><a name="modelarts_03_0066"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Details About a Visualization Job</h1>
|
|
<div id="body8662426"><div class="section" id="modelarts_03_0066__en-us_topic_0131202684_section694510305355"><h4 class="sectiontitle">Function</h4><p id="modelarts_03_0066__en-us_topic_0131202684_p8958807">This API is used to query the details about a specified visualization job based on the job name.</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0066__en-us_topic_0131202684_section20261580353"><h4 class="sectiontitle">URI</h4><p id="modelarts_03_0066__en-us_topic_0131202684_p69102242112">GET /v1/{project_id}/visualization-jobs/{job_id}</p>
|
|
</div>
|
|
<div class="p" id="modelarts_03_0066__en-us_topic_0131202684_p548518344112"><a href="#modelarts_03_0066__en-us_topic_0131202684_table569625523811">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="modelarts_03_0066__en-us_topic_0131202684_table569625523811"></a><a name="en-us_topic_0131202684_table569625523811"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0066__en-us_topic_0131202684_table569625523811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0066__en-us_topic_0131202684_row169945510386"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.2.2.5.1.1"><p id="modelarts_03_0066__en-us_topic_0131202684_p370019557384">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.5.1.2"><p id="modelarts_03_0066__en-us_topic_0131202684_p2702115512388">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.3.2.2.5.1.3"><p id="modelarts_03_0066__en-us_topic_0131202684_p1704955163819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.3.2.2.5.1.4"><p id="modelarts_03_0066__en-us_topic_0131202684_p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0066__en-us_topic_0131202684_row187062555388"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p570711558389">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p4813935511624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p147095558384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_03_0066__en-us_topic_0131202684_p4972959911831">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_0066__en-us_topic_0131202684_row11263047124417"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.2.5.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p1263144710445">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.5.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p2118234711624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.2.2.5.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p426344719446">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.2.2.5.1.4 "><p id="modelarts_03_0066__en-us_topic_0131202684_p2263247174418">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0066__en-us_topic_0131202684_section722833995517"><h4 class="sectiontitle">Request Body</h4><p id="modelarts_03_0066__en-us_topic_0131202684_p12285142137">None</p>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0066__en-us_topic_0131202684_section54078976"><h4 class="sectiontitle">Response Body</h4><p id="modelarts_03_0066__en-us_topic_0131202684_p199196243314"><a href="#modelarts_03_0066__en-us_topic_0131202684_table6495326155010">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="modelarts_03_0066__en-us_topic_0131202684_table6495326155010"></a><a name="en-us_topic_0131202684_table6495326155010"></a><table cellpadding="4" cellspacing="0" summary="" id="modelarts_03_0066__en-us_topic_0131202684_table6495326155010" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="modelarts_03_0066__en-us_topic_0131202684_row5494926185016"><th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.5.3.2.4.1.1"><p id="modelarts_03_0066__en-us_topic_0131202684_p5492172695012">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.5.3.2.4.1.2"><p id="modelarts_03_0066__en-us_topic_0131202684_p44936269505">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="69%" id="mcps1.3.5.3.2.4.1.3"><p id="modelarts_03_0066__en-us_topic_0131202684_p10120191554012">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="modelarts_03_0066__en-us_topic_0131202684_row16495526105016"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p149419264504">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p1049522615015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p93441345174210">Error message of a failed API call.</p>
|
|
<p id="modelarts_03_0066__en-us_topic_0131202684_p17495152635015">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row349515264509"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p16495132665014">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p9495926155011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_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_0066__en-us_topic_0131202684_p4896890711131">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row112646410564"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p5106217311735">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p4239538711735">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p1147433311735">Name of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row1385172710575"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p766713111735">service_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p1705789711735">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p3951239111735">Endpoint of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row184951555165111"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p74951955205110">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p7495125510519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p5496145513513">Charged resource ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row1486169145216"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p78615955214">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p1186149145219">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p128614975218">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row182976613523"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p1029846165212">job_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p4298136145216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p102981368527">Description of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row6374824520"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p637462125218">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p5374162135213">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p13749235213">Visualization job running duration, in milliseconds</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row7568357115415"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p14568155715411">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p10568857175413">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p15568185711540">Time when a visualization job is created, in timestamp format</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row3724153205512"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p772453115517">train_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p672416315557">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p187241730559">OBS path of the visualization job output file</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="modelarts_03_0066__en-us_topic_0131202684_row159660105516"><td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.5.3.2.4.1.1 "><p id="modelarts_03_0066__en-us_topic_0131202684_p659618045517">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.5.3.2.4.1.2 "><p id="modelarts_03_0066__en-us_topic_0131202684_p15961003556">Int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69%" headers="mcps1.3.5.3.2.4.1.3 "><p id="modelarts_03_0066__en-us_topic_0131202684_p1059618065510">Status of a visualization job. For details about the job statuses, see <a href="modelarts_03_0074.html">Job Statuses</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="modelarts_03_0066__en-us_topic_0131202684_section19267121218210"><h4 class="sectiontitle">Samples</h4><p id="modelarts_03_0066__en-us_topic_0131202684_p76171336420">The following shows how to query the visualization job whose ID is 10.</p>
|
|
<ul id="modelarts_03_0066__en-us_topic_0131202684_ul865811485616"><li id="modelarts_03_0066__en-us_topic_0131202684_li10001026">Sample request<pre class="screen" id="modelarts_03_0066__en-us_topic_0131202684_screen9371153731111">GET https://endpoint/v1/{project_id}/visualization-jobs/10</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="modelarts_03_0066__en-us_topic_0131202684_ul656133845018"><li id="modelarts_03_0066__en-us_topic_0131202684_li1957183816501">Successful sample response<pre class="screen" id="modelarts_03_0066__en-us_topic_0131202684_screen111001645141117">{
|
|
"duration": 33000,
|
|
"service_url": "https://XXX/modelarts2/tensorboard/04f679b17380d32a2f32c00335c4b5ba/197/",
|
|
"job_name": "apiTest-11",
|
|
"create_time": 1565149736000,
|
|
"train_url": "/wph-test/zl-test/Flowers-Set/ApiTest/",
|
|
"job_id": 197,
|
|
"job_desc": "ModelArts API Dialtest",
|
|
"resource_id": "e17dd874-b5e0-4e9b-aaf0-22b045ad8571",
|
|
"remaining_duration": null,
|
|
"is_success": true,
|
|
"status": 7
|
|
}</pre>
|
|
</li><li id="modelarts_03_0066__en-us_topic_0131202684_li117118388508">Failed sample response<pre class="screen" id="modelarts_03_0066__en-us_topic_0131202684_screen18756205215116">{
|
|
"is_success": false,
|
|
"error_message": "The length of search content should be in [0,100]",
|
|
"error_code": "ModelArts.0104"
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="modelarts_03_0066__en-us_topic_0131202684_section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="modelarts_03_0066__en-us_topic_0131202684_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_0066__section27281325181210"><h4 class="sectiontitle">Error Codes</h4><p id="modelarts_03_0066__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>
|
|
|