doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0007.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

199 lines
19 KiB
HTML

<a name="dataartsstudio_02_0007"></a><a name="dataartsstudio_02_0007"></a>
<h1 class="topictitle1">API Overview</h1>
<div id="body8662426"><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p11112662153235"><span id="dataartsstudio_02_0007__text57841510161910">DataArts Studio</span> provides self-developed APIs that comply with RESTful API design specifications. You can call those APIs to perform operations on <span id="dataartsstudio_02_0007__text019414182110">DataArts Studio</span>.</p>
<div class="section" id="dataartsstudio_02_0007__section15678351346"><h4 class="sectiontitle">DataArts Migration APIs</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0007__table2232559154016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>DataArts Migration APIs</caption><thead align="left"><tr id="dataartsstudio_02_0007__en-us_topic_0108272809_rcbd6963cbf0e484f9ece7459bee48cd5"><th align="left" class="cellrowborder" valign="top" width="20.14%" id="mcps1.3.2.2.2.5.1.1"><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p51621169582">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.76%" id="mcps1.3.2.2.2.5.1.2"><p id="dataartsstudio_02_0007__en-us_topic_0108272809_a5fcf863a5c724fb5bafc395df1b24239">API</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.740000000000002%" id="mcps1.3.2.2.2.5.1.3"><p id="dataartsstudio_02_0007__en-us_topic_0108272809_a4ab9480388da4ec8bc0724d32edbe658">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.36%" id="mcps1.3.2.2.2.5.1.4"><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p3213161318486">Maximum Number of Requests Made Per User Per Minute</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0007__en-us_topic_0108272809_r831c9343c1b6412fbc5fa698fbd20a3a"><td class="cellrowborder" rowspan="7" valign="top" width="20.14%" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p101625616586"><a href="topic_300000000_8.html">Cluster Management</a></p>
</td>
<td class="cellrowborder" valign="top" width="17.76%" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p668332715911">Creating a Cluster</p>
</td>
<td class="cellrowborder" valign="top" width="30.740000000000002%" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p115416241412">Used to create a CDM cluster.</p>
</td>
<td class="cellrowborder" valign="top" width="31.36%" headers="mcps1.3.2.2.2.5.1.4 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p776418524518">5</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row19328462591"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1732920655917">Querying the Cluster List</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1832918635912">Used to query the list of CDM clusters.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p147645519452">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row1529814222599"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p112981022115917">Querying Cluster Details</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p11298922145910">Used to query the details of a CDM cluster.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1499020612490">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row943219171593"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p6433171713594">Restarting a Cluster</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p16433151795919">Used to restart a CDM cluster.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p109331392494">20</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row152842125591"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p92848121599">Deleting a Cluster</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p112848121597">Used to delete a CDM cluster.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p133292114527">20</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row2073712596209"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p15737145972017">Stopping a Cluster</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p18737145918206">Used to stop a CDM cluster.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p485062110529">20</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row168001843142019"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p6800443152012">Starting a Cluster</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p17800144342014">Used to start a CDM cluster.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p16445718104915">20</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_r97d9cdac29074b28a344a0d86496d90b"><td class="cellrowborder" rowspan="4" valign="top" width="20.14%" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__p1650516324115"><a href="topic_300000002_6.html">Link Management</a></p>
</td>
<td class="cellrowborder" valign="top" width="17.76%" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1162520492612">Creating a Link</p>
</td>
<td class="cellrowborder" valign="top" width="30.740000000000002%" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p11795717145">Used to connect to a data source. </p>
</td>
<td class="cellrowborder" valign="top" width="31.36%" headers="mcps1.3.2.2.2.5.1.4 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1440511523522">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row1062594912611"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p261419395124">Querying a Link</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p166251249865">Used to query the link list.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p176211024195219">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row1161483912128"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p20912153551214">Modifying a Link</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1261453911123">Used to modify the link configuration.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1836122519524">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row10912123512121"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1494103112124">Deleting a Link</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p109138355127">Used to delete a link.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p205291028145213">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row25964459102952"><td class="cellrowborder" rowspan="9" valign="top" width="20.14%" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__p106761133411"><a href="topic_300000001_6.html">Job Management</a></p>
</td>
<td class="cellrowborder" valign="top" width="17.76%" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p30519192102952">Creating a Job in a Specific Cluster</p>
</td>
<td class="cellrowborder" valign="top" width="30.740000000000002%" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p56135479102952">Used to create a data migration job in a specific CDM cluster. The job will not automatically start.</p>
</td>
<td class="cellrowborder" valign="top" width="31.36%" headers="mcps1.3.2.2.2.5.1.4 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p119611056105215">1200</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row1172354525"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1572515419214">Creating and Executing a Job in a Random Cluster</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1372514529">Used to select a random cluster in the running state from the specified clusters and create and execute a data migration job.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p46481657165215">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row1576002410306"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p5386732610306">Querying a Job</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p117731710306">Used to query the job list.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p969563695210">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row1210575410309"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p3607132810309">Modifying a Job</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p3609642710309">Used to modify the job configuration.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p7550137105215">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row34472636103012"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p18094461103012">Starting a Job</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p56365238103012">Used to start a data migration job.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p34787017538">1200</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row14941532103156"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p52451665103156">Stopping a Job</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p20726438103156">Used to stop a running job.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p16177115534">1200</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row1744768310320"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p5363966910320">Querying Job Status</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p4984589410320">Used to query the running status of a job.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p639244219525">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row3000249810324"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1609414910324">Querying Job Execution History</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p2855767310324">Used to query the historical status of job execution.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p62911843145219">120</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0108272809_row1942734110327"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p2305383310327">Deleting a job</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p5542115710327">Used to delete a job.</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.2.5.1.3 "><p id="dataartsstudio_02_0007__en-us_topic_0108272809_p1593254310522">120</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0007__section09162416520"><h4 class="sectiontitle">DataArts Factory APIs</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0007__en-us_topic_0181281314_table3537164813475" frame="border" border="1" rules="all"><caption><b>Table 2 </b>DataArts Factory APIs</caption><thead align="left"><tr id="dataartsstudio_02_0007__en-us_topic_0181281314_row3537154813475"><th align="left" class="cellrowborder" valign="top" width="17.080000000000002%" id="mcps1.3.3.2.2.3.1.1"><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p7538144814714">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="82.92%" id="mcps1.3.3.2.2.3.1.2"><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p5538104834711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0007__en-us_topic_0181281314_row65381348194716"><td class="cellrowborder" valign="top" width="17.080000000000002%" headers="mcps1.3.3.2.2.3.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p25381148174716"><a href="dataartsstudio_02_0049.html">Connection Management APIs (To Be Taken Offline)</a></p>
</td>
<td class="cellrowborder" valign="top" width="82.92%" headers="mcps1.3.3.2.2.3.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p145381548194717">Used to create, edit, delete, and export data connections, query the data connection list, and query data connection details. For details, see <span class="menucascade" id="dataartsstudio_02_0007__menucascade20688182335311"><b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol17688023175311">DataArts Factory</span></b> &gt; <b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol268862345315">Data Management</span></b> &gt; <b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol191594135513">Creating a Data Connection</span></b></span> in the <em id="dataartsstudio_02_0007__i1688123175312">User Guide</em>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0181281314_row6538144810473"><td class="cellrowborder" valign="top" width="17.080000000000002%" headers="mcps1.3.3.2.2.3.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p1753824844710"><a href="dataartsstudio_02_0056.html">Script Development APIs</a></p>
</td>
<td class="cellrowborder" valign="top" width="82.92%" headers="mcps1.3.3.2.2.3.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p053884834718">Used to delete and execute scripts. For details, see <span class="menucascade" id="dataartsstudio_02_0007__menucascade15121507456"><b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol10512155024517">DataArts Factory</span></b> &gt; <b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol23689168468">Script Development</span></b></span> in the <em id="dataartsstudio_02_0007__i92086995312">User Guide</em>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0181281314_row1453815486472"><td class="cellrowborder" valign="top" width="17.080000000000002%" headers="mcps1.3.3.2.2.3.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p1153884812475"><a href="dataartsstudio_02_0060.html">Resource Management APIs</a></p>
</td>
<td class="cellrowborder" valign="top" width="82.92%" headers="mcps1.3.3.2.2.3.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p10538448154717">Used to perform operations such as deleting resources. For details, see <span class="menucascade" id="dataartsstudio_02_0007__menucascade1912119174476"><b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol7121161784711">DataArts Factory</span></b> &gt; <b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol8765114824816">Configuration and Management</span></b> &gt; <b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol73261058154820">Managing a Resource</span></b></span> in the <em id="dataartsstudio_02_0007__i168816513519">User Guide</em>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0007__en-us_topic_0181281314_row175381848114710"><td class="cellrowborder" valign="top" width="17.080000000000002%" headers="mcps1.3.3.2.2.3.1.1 "><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p1753874816477"><a href="dataartsstudio_02_0062.html">Job Development APIs</a></p>
</td>
<td class="cellrowborder" valign="top" width="82.92%" headers="mcps1.3.3.2.2.3.1.2 "><p id="dataartsstudio_02_0007__en-us_topic_0181281314_p2053884813479">Used to delete jobs and query job files. For details, see <span class="menucascade" id="dataartsstudio_02_0007__menucascade4850182718497"><b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol88446278499">DataArts Factory</span></b> &gt; <b><span class="uicontrol" id="dataartsstudio_02_0007__uicontrol118501527164916">Job Development</span></b></span> in the <em id="dataartsstudio_02_0007__i1845161210537">User Guide</em>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>