vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0104.html
Xiong, Chen Xiao 14a6d65e8c DataArts API 20240130 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2024-03-01 11:46:15 +00:00

165 lines
18 KiB
HTML
Raw Blame History

<a name="dataartsstudio_02_0104"></a><a name="dataartsstudio_02_0104"></a>
<h1 class="topictitle1">Querying a Resource</h1>
<div id="body0000001151254685"><div class="section" id="dataartsstudio_02_0104__en-us_topic_0181281291_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0104__en-us_topic_0181281291_p1912913467404">This API is used to query resource details. A resource contains various files such as JAR, ZIP, and properties files. A created resource can be used in job nodes such as DLI Spark and MRS Spark.</p>
</div>
<div class="section" id="dataartsstudio_02_0104__en-us_topic_0181281291_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0104__en-us_topic_0181281291_ul145591424184717"><li id="dataartsstudio_02_0104__en-us_topic_0181281291_li356152404715">URI format<p id="dataartsstudio_02_0104__en-us_topic_0181281291_p076674419427"><a name="dataartsstudio_02_0104__en-us_topic_0181281291_li356152404715"></a><a name="en-us_topic_0181281291_li356152404715"></a>GET /v1/{project_id}/resources/{resource_id}</p>
</li></ul>
<ul id="dataartsstudio_02_0104__en-us_topic_0181281291_ul1370917277482"><li id="dataartsstudio_02_0104__en-us_topic_0181281291_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="19.919999999999998%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.41%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.5%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.169999999999995%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.169999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="projectid_accountid.html">Project ID and Account ID</a>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0104__en-us_topic_0181281291_row1125111514"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_p151262018113">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_p7123132312118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.5%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_p13125182319120">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.169999999999995%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_p355162716111">Resource ID. For details about how to obtain the resource ID, see <a href="dataartsstudio_02_0105.html">Querying a Resource List</a>. The returned ID is <strong id="dataartsstudio_02_0104__b76728951910746">resource_id</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0104__en-us_topic_0181281291_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0104__en-us_topic_0181281291_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_p131491731112013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.93%" id="mcps1.3.3.2.2.5.1.2"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_p3149113112204">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.3.2.2.5.1.3"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_p13149173119204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.3.2.2.5.1.4"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_p1150183116205">workspace</p>
</td>
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_p4150531152016">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_p181505317209">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0104__b1164101218497">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0104__en-us_topic_0181281291_section1151611165504"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0104__en-us_topic_0181281291_table1940660182913" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Resource parameters</caption><thead align="left"><tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_row1475134418345"><th align="left" class="cellrowborder" valign="top" width="21.39%" id="mcps1.3.4.2.2.5.1.1"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p1275244423417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.33%" id="mcps1.3.4.2.2.5.1.2"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p1375504413341">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.67%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p675774416349">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.61%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p475920448344">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_row1760344113410"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p5760124443410">name</p>
</td>
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p476174473411">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p6763114463415">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p1376304411342">Name of the resource. The name contains a maximum of 32 characters, including only letters, numbers, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_row7763244193418"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p1676464463414">type</p>
</td>
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p776544410349">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p7766174423419">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p0767244123410">Resource type.</p>
<ul id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_ul1276716442349"><li id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_li676811443344">archive</li><li id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_li176818449341">file</li><li id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_li167711644103416">jar</li></ul>
</td>
</tr>
<tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_row2416130182519"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p1141615072518">location</p>
</td>
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p1416120152512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p2416001259">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p74165052512">OBS path for storing the resource file. When <strong id="dataartsstudio_02_0104__b18092191497">type</strong> is set to <strong id="dataartsstudio_02_0104__b181518199499">jar</strong>, <strong id="dataartsstudio_02_0104__b7815819204910">location</strong> is the path for storing the main JAR package. The path contains a maximum of 256 characters. For example, obs://myBucket/test.jar</p>
</td>
</tr>
<tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_row477184415342"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p8364132164320">dependFiles</p>
</td>
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p14363821194310">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p13627210437">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p336182124313">JAR package and properties file that the main JAR package depends on. The description contains a maximum of 10,240 characters.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_row97741244163419"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p53611021124318">desc</p>
</td>
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p1035842120431">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p10357121114319">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p163571221134318">Description of the resource. The description contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_row47771744133413"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p1135513219431">directory</p>
</td>
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p163541215438">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.67%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p8352102118434">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p1275984817177">Directory for storing the resource.</p>
<p id="dataartsstudio_02_0104__en-us_topic_0181281291_en-us_topic_0181281323_p123051357125016">Access the <span id="dataartsstudio_02_0104__text143381134203910"><span id="dataartsstudio_02_0104__text0337734193910">DataArts Studio</span></span> console and choose <strong id="dataartsstudio_02_0104__b9338103453917">Data Development</strong>. In the left navigation pane, choose <span class="menucascade" id="dataartsstudio_02_0104__menucascade113391634123914"><b><span class="uicontrol" id="dataartsstudio_02_0104__uicontrol1533983412392">Development</span></b> &gt; <b><span class="uicontrol" id="dataartsstudio_02_0104__uicontrol16339193423910">Develop Script</span></b></span>. In the directory tree of the script, you can view the created directories. The default directory is the <strong id="dataartsstudio_02_0104__b17646181810503">root</strong> directory.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0104__en-us_topic_0181281291_section358155716277"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dataartsstudio_02_0104__en-us_topic_0181281291_p1488816432455">View resource details.<pre class="screen" id="dataartsstudio_02_0104__en-us_topic_0181281291_screen165211354306">GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/resources/3624d1c3-5df5-4f20-9af9-98eadad6c5f9</pre>
</div>
</div>
<div class="section" id="dataartsstudio_02_0104__section24158545416"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0104__en-us_topic_0181281291_ul14272355144816"><li id="dataartsstudio_02_0104__en-us_topic_0181281291_li149491320463">Success response<pre class="screen" id="dataartsstudio_02_0104__en-us_topic_0181281291_screen198181649153014">{
"name": "test",
"type": "jar",
"location": "obs://dlf-test/hadoop-mapreduce-examples-2.4.1.jar",
"dependFiles": ["obs://dlf-test/depend1.jar","obs://dlf-test/depend2.jar"],
"desc": "test",
"directory":"/resource"
}</pre>
</li><li id="dataartsstudio_02_0104__en-us_topic_0181281291_li227295594811">Failure response<p id="dataartsstudio_02_0104__en-us_topic_0181281291_p17868101111567"><a name="dataartsstudio_02_0104__en-us_topic_0181281291_li227295594811"></a><a name="en-us_topic_0181281291_li227295594811"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0104__en-us_topic_0181281291_screen1627205594818">{
"error_code":"DLF.6241",
"error_msg":"The resource information does not exist."
}</pre>
</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0104__en-us_topic_0181281291_section134313251487"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0104__en-us_topic_0181281291_p392415316492">See <a href="dataartsstudio_02_0310.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0060.html">Resource Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink