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>
165 lines
13 KiB
HTML
165 lines
13 KiB
HTML
<a name="EN-US_TOPIC_0000001909747500"></a><a name="EN-US_TOPIC_0000001909747500"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Details About a Visualization Job</h1>
|
|
<div id="body1536897563953"><div class="section" id="EN-US_TOPIC_0000001909747500__section694510305355"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001909747500__p8958807">This API is used to obtain the details about a specified visualization job based on the job name.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747500__section20261580353"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001909747500__p69102242112">GET /v1/{project_id}/visualization-jobs/{job_id}</p>
|
|
</div>
|
|
<div class="p" id="EN-US_TOPIC_0000001909747500__p548518344112"><a href="#EN-US_TOPIC_0000001909747500__table569625523811">Table 1</a> describes the required parameters.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747500__table569625523811"></a><a name="table569625523811"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747500__table569625523811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747500__row169945510386"><th align="left" class="cellrowborder" valign="top" width="19.59%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001909747500__p370019557384">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.67%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001909747500__p2702115512388">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.45%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001909747500__p1704955163819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.290000000000006%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001909747500__p23681614151847">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909747500__row187062555388"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747500__p570711558389">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747500__p4813935511624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.45%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747500__p147095558384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.290000000000006%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747500__p4972959911831">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_0000001909747500__row11263047124417"><td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001909747500__p1263144710445">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001909747500__p2118234711624">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.45%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001909747500__p426344719446">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.290000000000006%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001909747500__p2263247174418">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747500__section722833995517"><h4 class="sectiontitle">Request Body</h4><p id="EN-US_TOPIC_0000001909747500__p12285142137">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747500__section54078976"><h4 class="sectiontitle">Response Body</h4><p id="EN-US_TOPIC_0000001909747500__p199196243314"><a href="#EN-US_TOPIC_0000001909747500__table6495326155010">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001909747500__table6495326155010"></a><a name="table6495326155010"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001909747500__table6495326155010" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001909747500__row5494926185016"><th align="left" class="cellrowborder" valign="top" width="18.44%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000001909747500__p5492172695012">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.3%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000001909747500__p44936269505">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="69.26%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000001909747500__p10120191554012">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001909747500__row16495526105016"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p149419264504">error_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p1049522615015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__p93441345174210">Error message of a failed API call.</p>
|
|
<p id="EN-US_TOPIC_0000001909747500__p17495152635015">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row349515264509"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p16495132665014">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p9495926155011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__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_0000001909747500__p4896890711131">This parameter is not included when the API call succeeds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row112646410564"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p5106217311735">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p4239538711735">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__p1147433311735">Name of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row1385172710575"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p766713111735">service_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p1705789711735">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__p3951239111735">Endpoint of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row184951555165111"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p74951955205110">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p7495125510519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__p5496145513513">Charged resource ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row1486169145216"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p78615955214">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p1186149145219">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__p128614975218">ID of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row182976613523"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p1029846165212">job_desc</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p4298136145216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__p102981368527">Description of a visualization job</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row6374824520"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p637462125218">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p5374162135213">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__p13749235213">Visualization job running duration, in milliseconds</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row7568357115415"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p14568155715411">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p10568857175413">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__p15568185711540">Time when a visualization job is created, in timestamp format</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row3724153205512"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p772453115517">train_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p672416315557">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__p187241730559">OBS path of the visualization job output file</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001909747500__row159660105516"><td class="cellrowborder" valign="top" width="18.44%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001909747500__p659618045517">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.3%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001909747500__p15961003556">Int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="69.26%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001909747500__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="EN-US_TOPIC_0000001909747500__section19267121218210"><h4 class="sectiontitle">Sample Request</h4><p id="EN-US_TOPIC_0000001909747500__p76171336420">The following shows how to obtain the visualization job whose ID is 10.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0000001909747500__screen173614531435">GET https://endpoint/v1/{project_id}/visualization-jobs/10</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747500__section363052549"><h4 class="sectiontitle">Sample Response</h4><ul id="EN-US_TOPIC_0000001909747500__ul8634131315418"><li id="EN-US_TOPIC_0000001909747500__li563471316413">Successful response<pre class="screen" id="EN-US_TOPIC_0000001909747500__screen1863414133411">{
|
|
"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",
|
|
"status": 7
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001909747500__li10635101313413">Failed response<pre class="screen" id="EN-US_TOPIC_0000001909747500__screen1635713343">{
|
|
"error_message": "The length of search content should be in [0,100]",
|
|
"error_code": "ModelArts.0104"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001909747500__section16342114917109"><h4 class="sectiontitle">Status Code</h4><p id="EN-US_TOPIC_0000001909747500__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>
|
|
|