vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

DataArts API 20240130 version

Browse Source 
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>
This commit is contained in:
Xiong, Chen Xiao 2024-03-01 11:46:15 +00:00 committed by zuul
parent 2dbe7904be
commit 14a6d65e8c
161 changed files with 12075 additions and 7188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2571
docs/dataartsstudio/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

1027
docs/dataartsstudio/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

48
docs/dataartsstudio/api-ref/CreateAndStartRandomClusterJob.html → docs/dataartsstudio/api-ref/CreateAndStartRandomClusterJob_0.html
View File

File diff suppressed because it is too large Load Diff

655
docs/dataartsstudio/api-ref/CreateCluster.html
View File

File diff suppressed because it is too large Load Diff

655
docs/dataartsstudio/api-ref/CreateCluster_0.html Normal file
View File

File diff suppressed because it is too large Load Diff

803
docs/dataartsstudio/api-ref/CreateJob.html
View File

File diff suppressed because it is too large Load Diff

818
docs/dataartsstudio/api-ref/CreateJob_0.html Normal file
View File

File diff suppressed because it is too large Load Diff

78
docs/dataartsstudio/api-ref/CreateLink.html → docs/dataartsstudio/api-ref/CreateLink_0.html
View File

File diff suppressed because it is too large Load Diff

14
docs/dataartsstudio/api-ref/DeleteCluster.html → docs/dataartsstudio/api-ref/DeleteCluster_0.html
View File

@ -1,9 +1,9 @@
<a name="DeleteCluster"></a><a name="DeleteCluster"></a>
<a name="DeleteCluster_0"></a><a name="DeleteCluster_0"></a>
<h1 class="topictitle1">Deleting a Cluster</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a cluster.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v1.1/{project_id}/clusters/{cluster_id}</p>
<div class="section" id="DeleteCluster_0__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1.1/{project_id}/clusters/{cluster_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -38,7 +38,7 @@
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster_0__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
@ -61,7 +61,7 @@
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__request_CdmDeleteClusterReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster_0__request_CdmDeleteClusterReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p>Mandatory</p>
</th>
@ -87,7 +87,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__response_jobId" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster_0__response_jobId" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -119,7 +119,7 @@
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteCluster_0__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
@ -169,7 +169,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000_3.html">Cluster Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000_8.html">Cluster Management</a></div>
</div>
</div>

12
docs/dataartsstudio/api-ref/DeleteJob.html → docs/dataartsstudio/api-ref/DeleteJob_0.html
View File

@ -1,9 +1,9 @@
<a name="DeleteJob"></a><a name="DeleteJob"></a>
<a name="DeleteJob_0"></a><a name="DeleteJob_0"></a>
<h1 class="topictitle1">Deleting a Job</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a job.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}</p>
<div class="section" id="DeleteJob_0__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -47,7 +47,7 @@
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteJob__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteJob_0__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
@ -72,7 +72,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteJob__response_CdmCodeResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteJob_0__response_CdmCodeResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -108,7 +108,7 @@
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteJob__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteJob_0__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
@ -153,7 +153,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_2.html">Job Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_6.html">Job Management</a></div>
</div>
</div>

12
docs/dataartsstudio/api-ref/DeleteLink.html → docs/dataartsstudio/api-ref/DeleteLink_0.html
View File

@ -1,9 +1,9 @@
<a name="DeleteLink"></a><a name="DeleteLink"></a>
<a name="DeleteLink_0"></a><a name="DeleteLink_0"></a>
<h1 class="topictitle1">Deleting a Link</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a link.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}</p>
<div class="section" id="DeleteLink_0__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -47,7 +47,7 @@
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteLink__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteLink_0__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
@ -72,7 +72,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteLink__response_CdmCodeResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteLink_0__response_CdmCodeResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -108,7 +108,7 @@
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteLink__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteLink_0__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
@ -158,7 +158,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002_2.html">Link Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002_6.html">Link Management</a></div>
</div>
</div>

4
docs/dataartsstudio/api-ref/ErrorCode.html
View File

@ -8,9 +8,9 @@
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0311.html">CDM Error Codes</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0311.html">DataArts Migration Error Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0313.html">DLF Error Codes</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0313.html">DataArts Factory Error Codes</a></strong><br>
</li>
</ul>

62
docs/dataartsstudio/api-ref/ListClusters.html → docs/dataartsstudio/api-ref/ListClusters_0.html
View File

File diff suppressed because it is too large Load Diff

18
docs/dataartsstudio/api-ref/RestartCluster.html → docs/dataartsstudio/api-ref/RestartCluster_0.html
View File

@ -1,9 +1,9 @@
<a name="RestartCluster"></a><a name="RestartCluster"></a>
<a name="RestartCluster_0"></a><a name="RestartCluster_0"></a>
<h1 class="topictitle1">Restarting a Cluster</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to restart a cluster.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v1.1/{project_id}/clusters/{cluster_id}/action</p>
<div class="section" id="RestartCluster_0__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v1.1/{project_id}/clusters/{cluster_id}/action</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -38,7 +38,7 @@
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster_0__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
@ -61,7 +61,7 @@
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster__request_CdmRestartClusterReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster_0__request_CdmRestartClusterReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p>Mandatory</p>
</th>
@ -75,7 +75,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p><a href="#RestartCluster__request_restart">restart</a> object</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p><a href="#RestartCluster_0__request_restart">restart</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Cluster restart. For details about how to define the cluster to restart, see the descriptions of <strong>restart</strong> parameters.</p>
</td>
@ -84,7 +84,7 @@
</table>
</div>
<div class="tablenoborder"><a name="RestartCluster__request_restart"></a><a name="request_restart"></a><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster__request_restart" frame="border" border="1" rules="all"><caption><b>Table 4 </b>restart</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><a name="RestartCluster_0__request_restart"></a><a name="request_restart"></a><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster_0__request_restart" frame="border" border="1" rules="all"><caption><b>Table 4 </b>restart</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p>Mandatory</p>
</th>
@ -163,7 +163,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster__response_jobId" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster_0__response_jobId" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -200,7 +200,7 @@
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="RestartCluster_0__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
@ -250,7 +250,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000_3.html">Cluster Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000_8.html">Cluster Management</a></div>
</div>
</div>

68
docs/dataartsstudio/api-ref/ShowClusterDetail.html → docs/dataartsstudio/api-ref/ShowClusterDetail_0.html
View File

File diff suppressed because it is too large Load Diff

24
docs/dataartsstudio/api-ref/ShowJobStatus.html → docs/dataartsstudio/api-ref/ShowJobStatus_0.html
View File

@ -1,9 +1,9 @@
<a name="ShowJobStatus"></a><a name="ShowJobStatus"></a>
<a name="ShowJobStatus_0"></a><a name="ShowJobStatus_0"></a>
<h1 class="topictitle1">Querying Job Status</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the job status.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/status</p>
<div class="section" id="ShowJobStatus_0__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/status</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -47,7 +47,7 @@
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus_0__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
@ -72,7 +72,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus__response_CdmQueryStatusResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus_0__response_CdmQueryStatusResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -82,7 +82,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>submissions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ShowJobStatus__response_Submission">Submission</a> objects</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ShowJobStatus_0__response_Submission">Submission</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Job running information. For details, see the descriptions of <strong>submission</strong> parameters.</p>
</td>
@ -91,7 +91,7 @@
</table>
</div>
<div class="tablenoborder"><a name="ShowJobStatus__response_Submission"></a><a name="response_Submission"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus__response_Submission" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Submission</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><a name="ShowJobStatus_0__response_Submission"></a><a name="response_Submission"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus_0__response_Submission" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Submission</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
</th>
@ -115,7 +115,7 @@
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>counters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p><a href="#ShowJobStatus__response_counters">counters</a> object</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p><a href="#ShowJobStatus_0__response_counters">counters</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Job running result statistics. This parameter is available only when <strong>status</strong> is <strong>SUCCEEDED</strong>. For details, see the description of the <strong>counters</strong> parameter.</p>
</td>
@ -251,7 +251,7 @@
</table>
</div>
<div class="tablenoborder"><a name="ShowJobStatus__response_counters"></a><a name="response_counters"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus__response_counters" frame="border" border="1" rules="all"><caption><b>Table 5 </b>counters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><a name="ShowJobStatus_0__response_counters"></a><a name="response_counters"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus_0__response_counters" frame="border" border="1" rules="all"><caption><b>Table 5 </b>counters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p>Type</p>
</th>
@ -261,7 +261,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p>org.apache.sqoop.submission.counter.SqoopCounters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p><a href="#ShowJobStatus__response_counter">counter</a> object</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p><a href="#ShowJobStatus_0__response_counter">counter</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p>Job running result statistics. For details, see the descriptions of <strong>counter</strong> parameters.</p>
</td>
@ -270,7 +270,7 @@
</table>
</div>
<div class="tablenoborder"><a name="ShowJobStatus__response_counter"></a><a name="response_counter"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus__response_counter" frame="border" border="1" rules="all"><caption><b>Table 6 </b>counter</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><a name="ShowJobStatus_0__response_counter"></a><a name="response_counter"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus_0__response_counter" frame="border" border="1" rules="all"><caption><b>Table 6 </b>counter</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p>Type</p>
</th>
@ -367,7 +367,7 @@
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowJobStatus_0__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
@ -387,7 +387,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_2.html">Job Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_6.html">Job Management</a></div>
</div>
</div>

36
docs/dataartsstudio/api-ref/ShowJobs.html → docs/dataartsstudio/api-ref/ShowJobs_0.html
View File

File diff suppressed because it is too large Load Diff

64
docs/dataartsstudio/api-ref/ShowLink.html → docs/dataartsstudio/api-ref/ShowLink_0.html
View File

File diff suppressed because it is too large Load Diff

24
docs/dataartsstudio/api-ref/ShowSubmissions.html → docs/dataartsstudio/api-ref/ShowSubmissions_0.html
View File

@ -1,9 +1,9 @@
<a name="ShowSubmissions"></a><a name="ShowSubmissions"></a>
<a name="ShowSubmissions_0"></a><a name="ShowSubmissions_0"></a>
<h1 class="topictitle1">Querying Job Execution History</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the job execution history.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/submissions</p>
<div class="section" id="ShowSubmissions_0__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/submissions</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -61,7 +61,7 @@
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions_0__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
@ -86,7 +86,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions__response_CdmQuerySubmissionsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions_0__response_CdmQuerySubmissionsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -96,7 +96,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>submissions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ShowSubmissions__response_Submission">Submission</a> objects</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ShowSubmissions_0__response_Submission">Submission</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Job running information. For details, see the descriptions of <strong>submission</strong> parameters.</p>
</td>
@ -126,7 +126,7 @@
</table>
</div>
<div class="tablenoborder"><a name="ShowSubmissions__response_Submission"></a><a name="response_Submission"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions__response_Submission" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Submission</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><a name="ShowSubmissions_0__response_Submission"></a><a name="response_Submission"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions_0__response_Submission" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Submission</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
</th>
@ -150,7 +150,7 @@
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>counters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p><a href="#ShowSubmissions__response_counters">counters</a> object</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p><a href="#ShowSubmissions_0__response_counters">counters</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Job running result statistics. This parameter is available only when <strong>status</strong> is <strong>SUCCEEDED</strong>. For details, see the description of the <strong>counters</strong> parameter.</p>
</td>
@ -286,7 +286,7 @@
</table>
</div>
<div class="tablenoborder"><a name="ShowSubmissions__response_counters"></a><a name="response_counters"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions__response_counters" frame="border" border="1" rules="all"><caption><b>Table 6 </b>counters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><a name="ShowSubmissions_0__response_counters"></a><a name="response_counters"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions_0__response_counters" frame="border" border="1" rules="all"><caption><b>Table 6 </b>counters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p>Type</p>
</th>
@ -296,7 +296,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p>org.apache.sqoop.submission.counter.SqoopCounters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p><a href="#ShowSubmissions__response_counter">counter</a> object</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p><a href="#ShowSubmissions_0__response_counter">counter</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p>Job running result statistics. For details, see the descriptions of <strong>counter</strong> parameters.</p>
</td>
@ -305,7 +305,7 @@
</table>
</div>
<div class="tablenoborder"><a name="ShowSubmissions__response_counter"></a><a name="response_counter"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions__response_counter" frame="border" border="1" rules="all"><caption><b>Table 7 </b>counter</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><a name="ShowSubmissions_0__response_counter"></a><a name="response_counter"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions_0__response_counter" frame="border" border="1" rules="all"><caption><b>Table 7 </b>counter</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p>Type</p>
</th>
@ -402,7 +402,7 @@
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowSubmissions_0__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
@ -422,7 +422,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_2.html">Job Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_6.html">Job Management</a></div>
</div>
</div>

14
docs/dataartsstudio/api-ref/StartCluster.html → docs/dataartsstudio/api-ref/StartCluster_0.html
View File

@ -1,9 +1,9 @@
<a name="StartCluster"></a><a name="StartCluster"></a>
<a name="StartCluster_0"></a><a name="StartCluster_0"></a>
<h1 class="topictitle1">Starting a Cluster</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to start a cluster.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v1.1/{project_id}/clusters/{cluster_id}/action</p>
<div class="section" id="StartCluster_0__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v1.1/{project_id}/clusters/{cluster_id}/action</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -38,7 +38,7 @@
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartCluster__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartCluster_0__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
@ -61,7 +61,7 @@
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartCluster__request_CdmStartClusterReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartCluster_0__request_CdmStartClusterReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p>Mandatory</p>
</th>
@ -86,7 +86,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartCluster__response_CdmStartAndStopClusterResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartCluster_0__response_CdmStartAndStopClusterResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -119,7 +119,7 @@
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartCluster__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartCluster_0__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
@ -169,7 +169,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000_3.html">Cluster Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000_8.html">Cluster Management</a></div>
</div>
</div>

16
docs/dataartsstudio/api-ref/StartJob.html → docs/dataartsstudio/api-ref/StartJob_0.html
View File

@ -1,9 +1,9 @@
<a name="StartJob"></a><a name="StartJob"></a>
<a name="StartJob_0"></a><a name="StartJob_0"></a>
<h1 class="topictitle1">Starting a Job</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to start a job.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/start</p>
<div class="section" id="StartJob_0__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/start</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -47,7 +47,7 @@
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartJob__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartJob_0__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
@ -72,7 +72,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartJob__response_CdmStartJobResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartJob_0__response_CdmStartJobResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -82,7 +82,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>submissions</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#StartJob__response_StartJobSubmission">StartJobSubmission</a> objects</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#StartJob_0__response_StartJobSubmission">StartJobSubmission</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Job running information. For details, see the descriptions of <strong>submission</strong> parameters.</p>
</td>
@ -91,7 +91,7 @@
</table>
</div>
<div class="tablenoborder"><a name="StartJob__response_StartJobSubmission"></a><a name="response_StartJobSubmission"></a><table cellpadding="4" cellspacing="0" summary="" id="StartJob__response_StartJobSubmission" frame="border" border="1" rules="all"><caption><b>Table 4 </b>StartJobSubmission</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><a name="StartJob_0__response_StartJobSubmission"></a><a name="response_StartJobSubmission"></a><table cellpadding="4" cellspacing="0" summary="" id="StartJob_0__response_StartJobSubmission" frame="border" border="1" rules="all"><caption><b>Table 4 </b>StartJobSubmission</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
</th>
@ -238,7 +238,7 @@
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartJob__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StartJob_0__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
@ -258,7 +258,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_2.html">Job Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_6.html">Job Management</a></div>
</div>
</div>

158
docs/dataartsstudio/api-ref/StopCluster.html
View File

File diff suppressed because it is too large Load Diff

16
docs/dataartsstudio/api-ref/StopJob.html → docs/dataartsstudio/api-ref/StopJob_0.html
View File

@ -1,9 +1,9 @@
<a name="StopJob"></a><a name="StopJob"></a>
<a name="StopJob_0"></a><a name="StopJob_0"></a>
<h1 class="topictitle1">Stopping a Job</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to stop a job.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/stop</p>
<div class="section" id="StopJob_0__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/stop</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -47,7 +47,7 @@
</div>
</div>
<div class="section"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopJob__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopJob_0__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p>Mandatory</p>
</th>
@ -72,7 +72,7 @@
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopJob__response_CdmStopJobResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopJob_0__response_CdmStopJobResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p>Type</p>
</th>
@ -82,7 +82,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>validation-result</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#StopJob__response_JobValidationResult">JobValidationResult</a> objects</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#StopJob_0__response_JobValidationResult">JobValidationResult</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Validation result. If the job fails to be stopped, the failure cause is returned. For details, see the <strong>validation-result</strong> parameter. If the job is stopped, an empty list is returned.</p>
</td>
@ -91,7 +91,7 @@
</table>
</div>
<div class="tablenoborder"><a name="StopJob__response_JobValidationResult"></a><a name="response_JobValidationResult"></a><table cellpadding="4" cellspacing="0" summary="" id="StopJob__response_JobValidationResult" frame="border" border="1" rules="all"><caption><b>Table 4 </b>JobValidationResult</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
<div class="tablenoborder"><a name="StopJob_0__response_JobValidationResult"></a><a name="response_JobValidationResult"></a><table cellpadding="4" cellspacing="0" summary="" id="StopJob_0__response_JobValidationResult" frame="border" border="1" rules="all"><caption><b>Table 4 </b>JobValidationResult</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p>Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p>Type</p>
</th>
@ -128,7 +128,7 @@
<pre class="screen">{ }</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopJob__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="StopJob_0__status_code" frame="border" border="1" rules="all"><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p>Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p>Description</p>
</th>
@ -148,7 +148,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_2.html">Job Management</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001_6.html">Job Management</a></div>
</div>
</div>

44
docs/dataartsstudio/api-ref/UpdateJob.html → docs/dataartsstudio/api-ref/UpdateJob_0.html
View File

File diff suppressed because it is too large Load Diff

79
docs/dataartsstudio/api-ref/UpdateLink.html → docs/dataartsstudio/api-ref/UpdateLink_0.html
View File

File diff suppressed because it is too large Load Diff

6
docs/dataartsstudio/api-ref/dataartsstudio_02_0001.html
View File

@ -10,14 +10,12 @@
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0006.html">Concepts</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0004.html">Endpoints</a></strong><br>
<li class="ulchildlink"><strong><a href="endpoint.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0314.html">Project ID and Account ID</a></strong><br>
<li class="ulchildlink"><strong><a href="projectid_accountid.html">Project ID and Account ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0350.html">DataArts Studio Instance ID and Workspace ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0316.html">Data Development Job ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0005.html">Constraints</a></strong><br>
</li>
</ul>

4
docs/dataartsstudio/api-ref/dataartsstudio_02_0002.html
View File

@ -2,8 +2,8 @@
<h1 class="topictitle1">Overview</h1>
<div id="body8662426"><p id="dataartsstudio_02_0002__en-us_topic_0181281294_en-us_topic_0170640573_en-us_topic_0170093943_p14359124953115">Welcome to <span id="dataartsstudio_02_0002__text138432331172">DataArts Studio</span>. <span id="dataartsstudio_02_0002__text1524111844">DataArts Studio</span> is a one-stop operations platform that provides data lifecycle management and intelligent data management for enterprises' digital operations. It provides functions such as DataArts Migration, DataArts Architecture, DataArts Factory, DataArts Quality, DataArts Catalog, and DataArts DataService. <span id="dataartsstudio_02_0002__text952472741816">DataArts Studio</span> supports intelligent construction of industrial knowledge libraries as well as data foundations such as big data storage and big data computing and analysis engines. <span id="dataartsstudio_02_0002__text1838733221814">DataArts Studio</span> helps you quickly construct intelligent end-to-end data systems from data ingestion to data analysis. It helps eliminate data silos, unify standards, accelerate monetization, and generally assist with digital transformation.</p>
<p id="dataartsstudio_02_0002__en-us_topic_0181281294_en-us_topic_0170640573_en-us_topic_0170093943_p43591949123114">This document describes how to use APIs to perform operations on <span id="dataartsstudio_02_0002__text102481440388">DataArts Studio</span> components, such as creating clusters and connections. </p>
<p id="dataartsstudio_02_0002__en-us_topic_0181281294_en-us_topic_0170640573_en-us_topic_0170093943_p1297413722313">Before calling a <span id="dataartsstudio_02_0002__text1980216520193">DataArts Studio</span> API, ensure that you have fully understood the concepts related to <span id="dataartsstudio_02_0002__text10802052141910">DataArts Studio</span>. For details, see section "Service Overview" in <em id="dataartsstudio_02_0002__i5803952141918">DataArts Studio </em><em id="dataartsstudio_02_0002__i16636182013132">User Manual</em>.</p>
<p id="dataartsstudio_02_0002__en-us_topic_0181281294_en-us_topic_0170640573_en-us_topic_0170093943_p43591949123114">This document describes how to use APIs to perform operations on <span id="dataartsstudio_02_0002__text102481440388">DataArts Studio</span> components, such as creating clusters and connections. For details about all supported operations, see <a href="dataartsstudio_02_0007.html">API Overview</a>.</p>
<p id="dataartsstudio_02_0002__p158033342714">Before calling a <span id="dataartsstudio_02_0002__text469033303316">DataArts Studio</span> API, ensure that you have fully understood the concepts related to <span id="dataartsstudio_02_0002__text13690163316335">DataArts Studio</span>. For details, see "Overview" in <em id="dataartsstudio_02_0002__i1169011334335"></em><em id="dataartsstudio_02_0002__i3690133163318"></em>.</p>
</div>
<div>
<div class="familylinks">

13
docs/dataartsstudio/api-ref/dataartsstudio_02_0004.html
View File

@ -1,13 +0,0 @@
<a name="dataartsstudio_02_0004"></a><a name="dataartsstudio_02_0004"></a>
<h1 class="topictitle1">Endpoints</h1>
<div id="body8662426"><div class="section" id="dataartsstudio_02_0004__en-us_topic_0000001089114743_section14543104315016"><h4 class="sectiontitle">Obtaining an Endpoint</h4><p id="dataartsstudio_02_0004__en-us_topic_0000001089114743_p15821453115417">An endpoint is the <strong id="dataartsstudio_02_0004__en-us_topic_0000001089114743_b3336611193312">request address</strong> for calling an API. Endpoints vary depending on services and regions.</p>
<p id="dataartsstudio_02_0004__en-us_topic_0000001089114743_p27115277328">You can obtain endpoints from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0001.html">Before You Start</a></div>
</div>
</div>

3
docs/dataartsstudio/api-ref/dataartsstudio_02_0005.html
View File

@ -1,7 +1,8 @@
<a name="dataartsstudio_02_0005"></a><a name="dataartsstudio_02_0005"></a>
<h1 class="topictitle1">Constraints</h1>
<div id="body8662426"><ul id="dataartsstudio_02_0005__en-us_topic_0181281296_en-us_topic_0170640576_en-us_topic_0170093946_ul16164549183915"><li id="dataartsstudio_02_0005__li3206484334">The restrictions on DataArts Catalog APIs are as follows:<ul id="dataartsstudio_02_0005__ul186171224143318"><li id="dataartsstudio_02_0005__li20759113712559">CDM jobs carry large volumes of data, which increases the database load. You are advised to periodically delete unused jobs.</li><li id="dataartsstudio_02_0005__li85661789562">If a large number of jobs are delivered in a short period, cluster resources may be exhausted.</li><li id="dataartsstudio_02_0005__li1877810115610">CDM is a batch offline migration tool. You are advised not to create a large number of small jobs using CDM.</li></ul>
<div id="body8662426"><ul id="dataartsstudio_02_0005__en-us_topic_0181281296_en-us_topic_0170640576_en-us_topic_0170093946_ul16164549183915"><li id="dataartsstudio_02_0005__li77371531205413"><p id="dataartsstudio_02_0005__p85136333541"><a name="dataartsstudio_02_0005__li77371531205413"></a><a name="li77371531205413"></a>An IAM user can pass the authentication and access <span id="dataartsstudio_02_0005__text57841510161910">DataArts Studio</span> through an API or SDK only if <strong id="dataartsstudio_02_0005__b1834015273813">Programmatic access</strong> is selected for <strong id="dataartsstudio_02_0005__b146218599421">Access Type</strong> during the creation of the IAM user.</p>
</li><li id="dataartsstudio_02_0005__li3206484334">The restrictions on DataArts Catalog APIs are as follows:<ul id="dataartsstudio_02_0005__ul186171224143318"><li id="dataartsstudio_02_0005__li20759113712559">CDM jobs carry large volumes of data, which increases the database load. You are advised to periodically delete unused jobs.</li><li id="dataartsstudio_02_0005__li85661789562">If a large number of jobs are delivered in a short period, cluster resources may be exhausted.</li><li id="dataartsstudio_02_0005__li1877810115610">CDM is a batch offline migration tool. You are advised not to create a large number of small jobs using CDM.</li></ul>
</li><li id="dataartsstudio_02_0005__li4699188341">For the constraints of other modules' APIs, see their API descriptions.</li></ul>
</div>
<div>

13
docs/dataartsstudio/api-ref/dataartsstudio_02_0006.html
View File

@ -1,11 +1,11 @@
<a name="dataartsstudio_02_0006"></a><a name="dataartsstudio_02_0006"></a>
<h1 class="topictitle1">Concepts</h1>
<div id="body8662426"><ul id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0170093947_ul128965163312"><li id="dataartsstudio_02_0006__en-us_topic_0181281346_li98711554337">Domain<p id="dataartsstudio_02_0006__en-us_topic_0181281346_p138711255113314"><a name="dataartsstudio_02_0006__en-us_topic_0181281346_li98711554337"></a><a name="en-us_topic_0181281346_li98711554337"></a>A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant users permissions. The domain should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.</p>
<div id="body8662426"><ul id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0170093947_ul128965163312"><li id="dataartsstudio_02_0006__en-us_topic_0181281346_li98711554337">Domain<p id="dataartsstudio_02_0006__en-us_topic_0181281346_p138711255113314"><a name="dataartsstudio_02_0006__en-us_topic_0181281346_li98711554337"></a><a name="en-us_topic_0181281346_li98711554337"></a>A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant users permissions. The account should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.</p>
</li><li id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_li15896816113116">User<p id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_p589691603117"><a name="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_li15896816113116"></a><a name="en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_li15896816113116"></a>A user is created in Identity and Access Management (IAM) to use cloud services. Each user has its own identity credentials (password and access keys).</p>
<p id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_p9896121653112">You can view the account ID and user ID in <a href="dataartsstudio_02_0314.html">Project ID and Account ID</a>. The account name, username, and password will be required for API authentication.</p>
<p id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_p9896121653112">You can view the account ID and user ID in <a href="projectid_accountid.html">Project ID and Account ID</a>. The account name, username, and password will be required for API authentication.</p>
</li><li id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_li3896216123113">Project<p id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_p10896181643118"><a name="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_li3896216123113"></a><a name="en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_li3896216123113"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. If you want more refined access control, create subprojects under a project and create resources in the subprojects. Then, grant users the permissions to access only specific resources in the subprojects.</p>
<div class="fignone" id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_fig1189614168311"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_image689661615316" src="en-us_image_0000001321929240.gif"></span></div>
<div class="fignone" id="dataartsstudio_02_0006__en-us_topic_0181281346_en-us_topic_0170640577_en-us_topic_0169294976_fig1189614168311"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="dataartsstudio_02_0006__image11300142314467" src="en-us_image_0000001828945753.png" width="494.76000000000005" height="209.1957" title="Click to enlarge" class="imgResize"></span></div>
</li></ul>
</div>
<div>
@ -14,3 +14,10 @@
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

198
docs/dataartsstudio/api-ref/dataartsstudio_02_0007.html
View File

File diff suppressed because it is too large Load Diff

2
docs/dataartsstudio/api-ref/dataartsstudio_02_0008.html
View File

@ -4,7 +4,7 @@
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0009.html">Making an API Request</a></strong><br>
<li class="ulchildlink"><strong><a href="making_request.html">Making an API Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0010.html">Authentication</a></strong><br>
</li>

247
docs/dataartsstudio/api-ref/dataartsstudio_02_0009.html
View File

File diff suppressed because it is too large Load Diff

21
docs/dataartsstudio/api-ref/dataartsstudio_02_0010.html
View File

@ -1,12 +1,14 @@
<a name="dataartsstudio_02_0010"></a><a name="dataartsstudio_02_0010"></a>
<h1 class="topictitle1">Authentication</h1>
<div id="body8662426"><div class="p" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p26613555143846">Requests for calling an API can be authenticated using either of the following methods:<ul id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_ul38195410143846"><li id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_li8214375143846">Token-based authentication: Requests are authenticated using a token.</li><li id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_li61384639143846">AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. AK/SK-based authentication is recommended because it is more secure than token-based authentication.</li></ul>
<div id="body8662426"><div class="p" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p26613555143846">Requests for calling an API can be authenticated using either of the following methods:<ul id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_ul38195410143846"><li id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_li8214375143846">Token-based authentication: Requests are authenticated using a token.</li><li id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_li61384639143846">AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair.</li></ul>
<div class="note" id="dataartsstudio_02_0010__note127591741175411"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dataartsstudio_02_0010__p676134155414">An IAM user can pass the authentication and access <span id="dataartsstudio_02_0010__dataartsstudio_02_0005_text57841510161910">DataArts Studio</span> through an API or SDK only if <strong id="dataartsstudio_02_0010__dataartsstudio_02_0005_b1834015273813">Programmatic access</strong> is selected for <strong id="dataartsstudio_02_0010__dataartsstudio_02_0005_b146218599421">Access Type</strong> during the creation of the IAM user.</p>
</div></div>
</div>
<div class="section" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_section2417768214391"><h4 class="sectiontitle">Token-based Authentication</h4><div class="note" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_note133321911123"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p1254514271026">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</p>
</div></div>
<p id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p18703477214">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to a request to get permissions for calling the API.</p>
<p id="dataartsstudio_02_0010__p587418197597">When calling the API to obtain a user token, you must set <strong id="dataartsstudio_02_0010__b2812192612464">auth.scope</strong> in the request body to <strong id="dataartsstudio_02_0010__b148128265461">project</strong>.</p>
<p id="dataartsstudio_02_0010__p587418197597">When calling the API to obtain a user token, you must set <strong id="dataartsstudio_02_0010__b1859819251283">auth.scope</strong> in the request body to <strong id="dataartsstudio_02_0010__b9598192515285">project</strong>.</p>
<pre class="screen" id="dataartsstudio_02_0010__screen1891571453115">{
"auth": {
"identity": {
@ -36,16 +38,16 @@ GET https://{{endpoint}}/v1/{project_id}/connections
Content-Type: application/json
<strong id="dataartsstudio_02_0010__b68753263013">X-Auth-Token: ABCDEFJ....</strong></pre>
</div>
<div class="section" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_section5887143815518"><a name="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_section5887143815518"></a><a name="en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_section5887143815518"></a><h4 class="sectiontitle">AK/SK-based Authentication</h4><div class="note" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_note26801820183918"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p12680102053918">AK/SK-based authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token-based authentication is recommended.</p>
<div class="section" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_section5887143815518"><h4 class="sectiontitle">AK/SK-based Authentication</h4><div class="note" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_note26801820183918"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p12680102053918">AK/SK-based authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token-based authentication is recommended.</p>
</div></div>
<p id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p171211559122516">In AK/SK-based authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.</p>
<ul id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_ul9783543561"><li id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_li8787541560">AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.</li><li id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_li47917548569">SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.</li></ul>
<div class="p" id="dataartsstudio_02_0010__p576822119389">To obtain an access key, perform the following steps:<ol id="dataartsstudio_02_0010__en-us_topic_0000001129241845_en-us_topic_0183643042_ol535183018588"><li id="dataartsstudio_02_0010__en-us_topic_0000001129241845_en-us_topic_0183643042_li1535103025819">Log in to the management console, move the cursor to the username in the upper right corner, and select <strong id="dataartsstudio_02_0010__en-us_topic_0000001129241845_b1586023610364">My Credentials</strong> from the drop-down list.</li><li id="dataartsstudio_02_0010__en-us_topic_0000001129241845_en-us_topic_0183643042_li173533018584">On the <strong id="dataartsstudio_02_0010__en-us_topic_0000001129241845_b149721128172418">My Credentials</strong> page, choose <strong id="dataartsstudio_02_0010__en-us_topic_0000001129241845_b15803656132414">Access Keys</strong>, and click <strong id="dataartsstudio_02_0010__en-us_topic_0000001129241845_b2452152020258">Create Access Key</strong>. See <a href="#dataartsstudio_02_0010__en-us_topic_0000001129241845_en-us_topic_0183643042_fig1552229194615">Figure 1</a>.<div class="fignone" id="dataartsstudio_02_0010__en-us_topic_0000001129241845_en-us_topic_0183643042_fig1552229194615"><a name="dataartsstudio_02_0010__en-us_topic_0000001129241845_en-us_topic_0183643042_fig1552229194615"></a><a name="en-us_topic_0000001129241845_en-us_topic_0183643042_fig1552229194615"></a><span class="figcap"><b>Figure 1 </b>Clicking Create Access Key</span><br><span><img id="dataartsstudio_02_0010__en-us_topic_0000001129241845_image20389043111611" src="en-us_image_0000001373408969.png"></span></div>
</li><li id="dataartsstudio_02_0010__en-us_topic_0000001129241845_en-us_topic_0183643042_li1535530185815">Click <strong id="dataartsstudio_02_0010__en-us_topic_0000001129241845_b8340319122819">OK</strong> and save the access key file as prompted. The access key file will be saved to your browser's configured download location. Open the <strong id="dataartsstudio_02_0010__en-us_topic_0000001129241845_b1940852512813">credentials.csv</strong> file to view <strong id="dataartsstudio_02_0010__en-us_topic_0000001129241845_b191574128718">Access Key Id</strong> and <strong id="dataartsstudio_02_0010__en-us_topic_0000001129241845_b175769149718">Secret Access Key</strong>.<div class="note" id="dataartsstudio_02_0010__en-us_topic_0000001129241845_note4554158201"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="dataartsstudio_02_0010__en-us_topic_0000001129241845_ul25541081906"><li id="dataartsstudio_02_0010__en-us_topic_0000001129241845_li175541819018">Only two access keys can be added for each user.</li><li id="dataartsstudio_02_0010__en-us_topic_0000001129241845_li3554138305">To ensure access key security, the access key is automatically downloaded only when it is generated for the first time and cannot be obtained from the management console later. Keep them properly.</li></ul>
<div class="p" id="dataartsstudio_02_0010__p576822119389">To obtain an access key, perform the following steps:<ol id="dataartsstudio_02_0010__en-us_topic_0000001668118762_en-us_topic_0183643042_ol535183018588"><li id="dataartsstudio_02_0010__en-us_topic_0000001668118762_en-us_topic_0183643042_li1535103025819">Log in to the management console, move the cursor to the username in the upper right corner, and select <strong id="dataartsstudio_02_0010__en-us_topic_0000001668118762_b1586023610364">My Credentials</strong> from the drop-down list.</li><li id="dataartsstudio_02_0010__en-us_topic_0000001668118762_en-us_topic_0183643042_li173533018584">On the <strong id="dataartsstudio_02_0010__en-us_topic_0000001668118762_b149721128172418">My Credentials</strong> page, choose <strong id="dataartsstudio_02_0010__en-us_topic_0000001668118762_b15803656132414">Access Keys</strong>, and click <strong id="dataartsstudio_02_0010__en-us_topic_0000001668118762_b2452152020258">Create Access Key</strong>. See <a href="#dataartsstudio_02_0010__en-us_topic_0000001668118762_en-us_topic_0183643042_fig1552229194615">Figure 1</a>.<div class="fignone" id="dataartsstudio_02_0010__en-us_topic_0000001668118762_en-us_topic_0183643042_fig1552229194615"><a name="dataartsstudio_02_0010__en-us_topic_0000001668118762_en-us_topic_0183643042_fig1552229194615"></a><a name="en-us_topic_0000001668118762_en-us_topic_0183643042_fig1552229194615"></a><span class="figcap"><b>Figure 1 </b>Clicking Create Access Key</span><br><span><img id="dataartsstudio_02_0010__en-us_topic_0000001668118762_image20389043111611" src="en-us_image_0000001668278494.png" width="274.3125" height="82.927362" title="Click to enlarge" class="imgResize"></span></div>
</li><li id="dataartsstudio_02_0010__en-us_topic_0000001668118762_en-us_topic_0183643042_li1535530185815">Click <strong id="dataartsstudio_02_0010__en-us_topic_0000001668118762_b8340319122819">OK</strong> and save the access key file as prompted. The access key file will be saved to your browser's configured download location. Open the <strong id="dataartsstudio_02_0010__en-us_topic_0000001668118762_b1940852512813">credentials.csv</strong> file to view <strong id="dataartsstudio_02_0010__en-us_topic_0000001668118762_b191574128718">Access Key Id</strong> and <strong id="dataartsstudio_02_0010__en-us_topic_0000001668118762_b175769149718">Secret Access Key</strong>.<div class="note" id="dataartsstudio_02_0010__en-us_topic_0000001668118762_note4554158201"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="dataartsstudio_02_0010__en-us_topic_0000001668118762_ul25541081906"><li id="dataartsstudio_02_0010__en-us_topic_0000001668118762_li175541819018">Only two access keys can be added for each user.</li><li id="dataartsstudio_02_0010__en-us_topic_0000001668118762_li3554138305">To ensure access key security, the access key is automatically downloaded only when it is generated for the first time and cannot be obtained from the management console later. Keep them properly.</li></ul>
</div></div>
</li></ol>
</div>
<div class="p" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p1866949103516">In AK/SK-based authentication, you can use an AK/SK to sign requests based on the signature algorithm or use the signing SDK to sign requests. For details about how to sign requests and use the signing SDK, see <em id="dataartsstudio_02_0010__i065113291432"></em><em id="dataartsstudio_02_0010__i133901219134711"></em><em id="dataartsstudio_02_0010__i33901319144715">API Request Signing Guide</em>.<div class="notice" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_note13908111122113"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p11657124333720">The signing SDKs are only used for signing requests and different from the SDKs provided by services.</p>
<div class="p" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p1866949103516">In AK/SK-based authentication, you can use an AK/SK to sign requests based on the signature algorithm or use the signing SDK to sign requests. For details about how to sign requests and use the signature SDK, see API Request Signing Guide.<div class="notice" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_note13908111122113"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p11657124333720">The signing SDKs are only used for signing requests and different from the SDKs provided by services.</p>
</div></div>
</div>
</div>
@ -56,3 +58,10 @@ Content-Type: application/json
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

13
docs/dataartsstudio/api-ref/dataartsstudio_02_0011.html
View File

@ -3,11 +3,11 @@
<h1 class="topictitle1">Response</h1>
<div id="body8662426"><div class="section" id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p4624111624411">After sending a request, you will receive a response, including a status code, response header, and response body.</p>
<p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p124381044137">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="dataartsstudio_02_0310.html">Status Codes</a>.</p>
<p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p2861496519">For example, if status code <strong id="dataartsstudio_02_0011__b127681048615">201</strong> is returned for calling the API used to obtain a user token, the request is successful.</p>
<p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p2861496519">For example, if status code <span class="parmvalue" id="dataartsstudio_02_0011__parmvalue1635961113219"><b>201</b></span> is returned for calling the API used to obtain a user token, the request is successful.</p>
</div>
<div class="section" id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_en-us_topic_0113746487_section61333484715"><h4 class="sectiontitle">Response Header</h4><p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p384320471837">Similar to a request, a response also has a header, for example, <strong id="dataartsstudio_02_0011__en-us_topic_0181281379_b653917122016">Content-Type</strong>.</p>
<p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p4430113619484"><a href="#dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_fig4865141011511">Figure 1</a> shows the response header fields for the API used to obtain a user token. The <strong id="dataartsstudio_02_0011__b1186813391722">x-subject-token</strong> header field is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
<div class="fignone" id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_fig4865141011511"><a name="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_fig4865141011511"></a><a name="en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Header fields of the response to the request for obtaining a user token</span><br><span><img id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_image48651610135113" src="en-us_image_0000001322248848.png"></span></div>
<p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p4430113619484"><a href="#dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_fig4865141011511">Figure 1</a> shows the response header fields for the API used to obtain a user token. The <strong id="dataartsstudio_02_0011__b158361922103320">x-subject-token</strong> header field is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
<div class="fignone" id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_fig4865141011511"><a name="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_fig4865141011511"></a><a name="en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Header fields of the response to the request for obtaining a user token</span><br><span><img id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_image48651610135113" src="en-us_image_0000001716290189.png" height="304.2375" width="523.6875" title="Click to enlarge" class="imgResize"></span></div>
</div>
<div class="section" id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_en-us_topic_0113746487_section2045571671419"><h4 class="sectiontitle">(Optional) Response Body</h4><p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_en-us_topic_0113746487_p64711881416">The body of a response is often returned in structured format (such as JSON or XML) as specified in the <strong id="dataartsstudio_02_0011__en-us_topic_0181281379_b1960611583341">Content-Type</strong> header field. The response body transfers content except the response header.</p>
</div>
@ -37,3 +37,10 @@
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

4
docs/dataartsstudio/api-ref/dataartsstudio_02_0012.html
View File

@ -5,9 +5,9 @@
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0013.html">Application Example</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0013.html">Example of Using DataArts Migration APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0015.html">Example of Using Data Development APIs</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0015.html">Example of Using DataArts Factory APIs</a></strong><br>
</li>
</ul>
</div>

268
docs/dataartsstudio/api-ref/dataartsstudio_02_0013.html
View File

File diff suppressed because it is too large Load Diff

4
docs/dataartsstudio/api-ref/dataartsstudio_02_0015.html
View File

@ -1,11 +1,11 @@
<a name="dataartsstudio_02_0015"></a><a name="dataartsstudio_02_0015"></a>
<h1 class="topictitle1">Example of Using Data Development APIs</h1>
<h1 class="topictitle1">Example of Using DataArts Factory APIs</h1>
<div id="body8662426"><div class="section" id="dataartsstudio_02_0015__section111703715274"><h4 class="sectiontitle">Scenarios</h4><p id="dataartsstudio_02_0015__p10260182818270"><span id="dataartsstudio_02_0015__text1945878152816">DataArts Studio</span> helps enterprises quickly build an end-to-end intelligent data system that covers the entire process from data ingestion to data analytics. The system can eliminate data silos, unify data standards, accelerate data monetization, and promote digital transformation.</p>
<p id="dataartsstudio_02_0015__p195354992720">The following describes how to create a script by calling the <a href="dataartsstudio_02_0097.html">Creating a Script</a> API. For details, see <a href="dataartsstudio_02_0008.html">Calling APIs</a>.</p>
</div>
<div class="section" id="dataartsstudio_02_0015__en-us_topic_0181281302_section65073658155317"><h4 class="sectiontitle">Prerequisites</h4><p id="dataartsstudio_02_0015__p116478353910">You have planned the region where Data Development is located and determined the endpoint for calling an API based on the region.</p>
<p id="dataartsstudio_02_0015__p37264282618">An endpoint is the <strong id="dataartsstudio_02_0015__en-us_topic_0000001082451448_b16300195371816">request address</strong> for calling an API. Endpoints vary depending on services and regions. You can obtain endpoints from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<p id="dataartsstudio_02_0015__p37264282618">An endpoint is the <strong id="dataartsstudio_02_0015__en-us_topic_0000001716158229_b16300195371816">request address</strong> for calling an API. Endpoints vary depending on services and regions. You can obtain endpoints of the service from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</div>
<div class="section" id="dataartsstudio_02_0015__en-us_topic_0181281302_section688409916227"><h4 class="sectiontitle">Creating a Shell Script</h4><div class="p" id="dataartsstudio_02_0015__en-us_topic_0181281302_p10011384112151">The following is an example of creating a shell script:<pre class="screen" id="dataartsstudio_02_0015__screen14130957454">{
"name":"echoTimeShell",

6
docs/dataartsstudio/api-ref/dataartsstudio_02_0016.html
View File

@ -4,11 +4,11 @@
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="topic_300000000_3.html">Cluster Management</a></strong><br>
<li class="ulchildlink"><strong><a href="topic_300000000_8.html">Cluster Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000001_2.html">Job Management</a></strong><br>
<li class="ulchildlink"><strong><a href="topic_300000001_6.html">Job Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000002_2.html">Link Management</a></strong><br>
<li class="ulchildlink"><strong><a href="topic_300000002_6.html">Link Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0260.html">Public Data Structures</a></strong><br>
</li>

10
docs/dataartsstudio/api-ref/dataartsstudio_02_0127.html → docs/dataartsstudio/api-ref/dataartsstudio_02_0048.html
View File

@ -1,21 +1,17 @@
<a name="dataartsstudio_02_0127"></a><a name="dataartsstudio_02_0127"></a>
<a name="dataartsstudio_02_0048"></a><a name="dataartsstudio_02_0048"></a>
<h1 class="topictitle1">DataArts Factory APIs</h1>
<div id="body0000001151254643"><p id="dataartsstudio_02_0127__p19515494"></p>
<div id="body0000001151254643"><p id="dataartsstudio_02_0048__p19515494"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0049.html">Connection Management APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0056.html">Script Development APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0060.html">Resource Management APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0062.html">Job Development APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0082.html">Data Structure</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0083.html">APIs to Be Taken Offline</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0049.html">Connection Management APIs (To Be Taken Offline)</a></strong><br>
</li>
</ul>
</div>

18
docs/dataartsstudio/api-ref/dataartsstudio_02_0049.html
View File

@ -1,25 +1,27 @@
<a name="dataartsstudio_02_0049"></a><a name="dataartsstudio_02_0049"></a>
<h1 class="topictitle1">Connection Management APIs</h1>
<h1 class="topictitle1">Connection Management APIs (To Be Taken Offline)</h1>
<div id="body0000001104334886"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0050.html">Creating a Connection</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0050.html">Creating a Connection (to Be Taken Offline)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0051.html">Querying a Connection List</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0051.html">Querying a Connection List (to Be Taken Offline)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0052.html">Viewing Connection Details</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0052.html">Querying Connection Details (to Be Taken Offline)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0053.html">Editing a Connection</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0053.html">Editing a Connection (to Be Taken Offline)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0054.html">Deleting a Connection</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0054.html">Deleting a Connection (to Be Taken Offline)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0055.html">Exporting a Connection</a></strong><br>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0055.html">Exporting Connections (to Be Taken Offline)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0106.html">Importing Connections (to Be Taken Offline)</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0127.html">DataArts Factory APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0048.html">DataArts Factory APIs</a></div>
</div>
</div>

439
docs/dataartsstudio/api-ref/dataartsstudio_02_0050.html
View File

File diff suppressed because it is too large Load Diff

144
docs/dataartsstudio/api-ref/dataartsstudio_02_0051.html
View File

File diff suppressed because it is too large Load Diff

100
docs/dataartsstudio/api-ref/dataartsstudio_02_0052.html
View File

File diff suppressed because it is too large Load Diff

108
docs/dataartsstudio/api-ref/dataartsstudio_02_0053.html
View File

File diff suppressed because it is too large Load Diff

62
docs/dataartsstudio/api-ref/dataartsstudio_02_0054.html
View File

File diff suppressed because it is too large Load Diff

52
docs/dataartsstudio/api-ref/dataartsstudio_02_0055.html
View File

File diff suppressed because it is too large Load Diff

12
docs/dataartsstudio/api-ref/dataartsstudio_02_0056.html
View File

@ -4,6 +4,16 @@
<div id="body0000001151254645"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0097.html">Creating a Script</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0098.html">Modifying a Script</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0099.html">Querying a Script</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0100.html">Querying a Script List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0101.html">Querying the Execution Result of a Script Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0057.html">Deleting a Script</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0058.html">Executing a Script</a></strong><br>
@ -13,7 +23,7 @@
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0127.html">DataArts Factory APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0048.html">DataArts Factory APIs</a></div>
</div>
</div>

74
docs/dataartsstudio/api-ref/dataartsstudio_02_0057.html
View File

@ -22,7 +22,7 @@
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.31%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="dataartsstudio_02_0314.html">Project ID and Account ID</a>.</p>
<td class="cellrowborder" valign="top" width="53.31%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_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_0057__en-us_topic_0181281364_row29566273563"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_p49561027135617">script_name</p>
@ -39,7 +39,7 @@
</div>
</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section10789431145710"><h4 class="sectiontitle">Request</h4>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0057__en-us_topic_0181281364_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0057__en-us_topic_0181281364_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_0057__en-us_topic_0181281364_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_0057__en-us_topic_0181281364_en-us_topic_0181281363_p3149113112204">Mandatory</p>
@ -63,14 +63,72 @@
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0057__en-us_topic_0181281374_table544435255017" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="dataartsstudio_02_0057__en-us_topic_0181281374_row444510523506"><th align="left" class="cellrowborder" valign="top" width="21.39%" id="mcps1.3.3.3.2.5.1.1"><p id="dataartsstudio_02_0057__en-us_topic_0181281374_p114461752155014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.45%" id="mcps1.3.3.3.2.5.1.2"><p id="dataartsstudio_02_0057__en-us_topic_0181281374_p344615216509">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.24%" id="mcps1.3.3.3.2.5.1.3"><p id="dataartsstudio_02_0057__en-us_topic_0181281374_p14446165285019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.92%" id="mcps1.3.3.3.2.5.1.4"><p id="dataartsstudio_02_0057__en-us_topic_0181281374_p17446105245018">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0057__row7274194512367"><td class="cellrowborder" valign="top" width="21.39%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dataartsstudio_02_0057__p175867202012">approvers</p>
</td>
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dataartsstudio_02_0057__p97581676203">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dataartsstudio_02_0057__p77589714204">List&lt;JobApprover&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="47.92%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dataartsstudio_02_0057__p1829214412218">Script approver. This parameter is required if the review function is enabled. For details, see <a href="#dataartsstudio_02_0057__table943565132314">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section561243517589"><h4 class="sectiontitle">Response</h4><p id="dataartsstudio_02_0057__en-us_topic_0181281364_p8527193217107">None.</p>
<div class="tablenoborder"><a name="dataartsstudio_02_0057__table943565132314"></a><a name="table943565132314"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0057__table943565132314" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Approver attributes</caption><thead align="left"><tr id="dataartsstudio_02_0057__row3436125112238"><th align="left" class="cellrowborder" valign="top" width="24.95750424957504%" id="mcps1.3.3.4.2.5.1.1"><p id="dataartsstudio_02_0057__p13603158182519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.987501249875013%" id="mcps1.3.3.4.2.5.1.2"><p id="dataartsstudio_02_0057__p060313892519">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.84751524847515%" id="mcps1.3.3.4.2.5.1.3"><p id="dataartsstudio_02_0057__p186034820259">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.207479252074794%" id="mcps1.3.3.4.2.5.1.4"><p id="dataartsstudio_02_0057__p16603158192520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0057__row7436175110233"><td class="cellrowborder" valign="top" width="24.95750424957504%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dataartsstudio_02_0057__p1713118288253">approverName</p>
</td>
<td class="cellrowborder" valign="top" width="24.987501249875013%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dataartsstudio_02_0057__p41311328132516">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="24.84751524847515%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dataartsstudio_02_0057__p61311286252">String</p>
</td>
<td class="cellrowborder" valign="top" width="25.207479252074794%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dataartsstudio_02_0057__p413162811253">Approver name</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section358155716277"><h4 class="sectiontitle">Example</h4><ul id="dataartsstudio_02_0057__en-us_topic_0181281364_ul18736591462"><li id="dataartsstudio_02_0057__en-us_topic_0181281364_li47367914616">Request<pre class="screen" id="dataartsstudio_02_0057__en-us_topic_0181281364_screen165211354306">DELETE /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/echoTime</pre>
</li></ul>
<ul id="dataartsstudio_02_0057__en-us_topic_0181281364_ul849401320464"><li id="dataartsstudio_02_0057__en-us_topic_0181281364_li149491320463">Success response<p id="dataartsstudio_02_0057__en-us_topic_0181281364_p9630194718227"><a name="dataartsstudio_02_0057__en-us_topic_0181281364_li149491320463"></a><a name="en-us_topic_0181281364_li149491320463"></a>HTTP status code 204</p>
</li><li id="dataartsstudio_02_0057__en-us_topic_0181281364_li697361214553">Failure response<p id="dataartsstudio_02_0057__en-us_topic_0181281364_p89261205810"><a name="dataartsstudio_02_0057__en-us_topic_0181281364_li697361214553"></a><a name="en-us_topic_0181281364_li697361214553"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0057__en-us_topic_0181281364_screen2818105917308">{
</div>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section561243517589"><h4 class="sectiontitle">Response Parameters</h4><p id="dataartsstudio_02_0057__en-us_topic_0181281364_p8527193217107">None.</p>
</div>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section358155716277"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="dataartsstudio_02_0057__en-us_topic_0181281364_screen165211354306">DELETE /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/echoTime</pre>
</div>
<p id="dataartsstudio_02_0057__p12371171920559">Delete a script when the review function is enabled.</p>
<pre class="screen" id="dataartsstudio_02_0057__screen1078142925618">DELETE /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/echoTime
{
"approvers": [
{
"approverName": "userName1"
},
{
"approverName": "userName2"
}
]
}</pre>
<div class="section" id="dataartsstudio_02_0057__section314111103"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0057__ul1114011101"><li id="dataartsstudio_02_0057__li111421118011">Success response<p id="dataartsstudio_02_0057__p121419111904"><a name="dataartsstudio_02_0057__li111421118011"></a><a name="li111421118011"></a>HTTP status code 204</p>
</li><li id="dataartsstudio_02_0057__li314101119013">Failure response<p id="dataartsstudio_02_0057__p1314151116017"><a name="dataartsstudio_02_0057__li314101119013"></a><a name="li314101119013"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0057__screen81418112009">{
"error_code":"DLF.6201",
"error_msg":"The script does not exist."
}</pre>

35
docs/dataartsstudio/api-ref/dataartsstudio_02_0058.html
View File

@ -23,7 +23,7 @@
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.18000000000001%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="dataartsstudio_02_0314.html">Project ID and Account ID</a>.</p>
<td class="cellrowborder" valign="top" width="53.18000000000001%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_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_0058__en-us_topic_0181281350_row28831818154718"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p5884111818473">script_name</p>
@ -39,7 +39,7 @@
</table>
</div>
</li></ul>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section10789431145710"><h4 class="sectiontitle">Request</h4>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0058__en-us_topic_0181281350_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.4.2.2.5.1.1"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p131491731112013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.93%" id="mcps1.3.4.2.2.5.1.2"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_en-us_topic_0181281363_p3149113112204">Mandatory</p>
@ -80,16 +80,16 @@
</td>
<td class="cellrowborder" valign="top" width="20.9%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1049114151287">Object</p>
</td>
<td class="cellrowborder" valign="top" width="47.38%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p174912151883">Script parameters of the Map&lt;String,String&gt; type. If a parameter is defined in the script, the parameter value is carried in the params. By default, this parameter is left blank.</p>
<td class="cellrowborder" valign="top" width="47.38%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p174912151883">Script parameters of the Map&lt;String,String&gt; type. If a parameter is defined in the script, the parameter value is carried in the params.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p153664418419">Script parameters refer to the parameters in the script content, as shown in the following figure.</p>
<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p980173515517"><span><img id="dataartsstudio_02_0058__en-us_topic_0181281350_image3615105812715" src="en-us_image_0000001373408961.png"></span></p>
<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p980173515517"><span><img id="dataartsstudio_02_0058__en-us_topic_0181281350_image3615105812715" src="en-us_image_0000001668210950.png" width="465.5" height="51.324301000000006" title="Click to enlarge" class="imgResize"></span></p>
</div>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section561243517589"><h4 class="sectiontitle">Response</h4>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section561243517589"><h4 class="sectiontitle">Response Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0058__en-us_topic_0181281350_table156150538710" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="dataartsstudio_02_0058__en-us_topic_0181281350_row16156531079"><th align="left" class="cellrowborder" valign="top" width="21.63%" id="mcps1.3.5.2.2.5.1.1"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p2615553976">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.209999999999999%" id="mcps1.3.5.2.2.5.1.2"><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p116153531175">Mandatory</p>
@ -113,17 +113,16 @@
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section358155716277"><h4 class="sectiontitle">Example</h4><ul id="dataartsstudio_02_0058__en-us_topic_0181281350_ul1469515810915"><li id="dataartsstudio_02_0058__en-us_topic_0181281350_li11695205817912">Request<pre class="screen" id="dataartsstudio_02_0058__en-us_topic_0181281350_screen1469510581692">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/dws_sql/execute</pre>
<pre class="screen" id="dataartsstudio_02_0058__en-us_topic_0181281350_screen186651501522">{
"params":{"tableVar":"citys",
"time":"2019-07-25"}
<div class="section" id="dataartsstudio_02_0058__section39388389289"><h4 class="sectiontitle">Example Request</h4><p id="dataartsstudio_02_0058__p92701320164718">Run the <strong id="dataartsstudio_02_0058__b37011410316">dws_sql</strong> script. In the script, the value of <strong id="dataartsstudio_02_0058__b1150192515318">tableVar</strong> is <strong id="dataartsstudio_02_0058__b2304133014319">citys</strong>, and the value of <strong id="dataartsstudio_02_0058__b12858143032">time</strong> is <strong id="dataartsstudio_02_0058__b23984494319">2019-07-25</strong>.</p>
<pre class="screen" id="dataartsstudio_02_0058__screen5938103812811">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/dws_sql/execute
{
"params": {
"tableVar": "citys",
"time": "2019-07-25"
}
}</pre>
</li></ul>
</div>
<ul id="dataartsstudio_02_0058__en-us_topic_0181281350_ul849401320464"><li id="dataartsstudio_02_0058__en-us_topic_0181281350_li1530714111306">Success response<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1430764112307"><a name="dataartsstudio_02_0058__en-us_topic_0181281350_li1530714111306"></a><a name="en-us_topic_0181281350_li1530714111306"></a>HTTP status code 200</p>
<pre class="screen" id="dataartsstudio_02_0058__en-us_topic_0181281350_screen1307241163019">{
"instanceId": "a1ad-448a-9d56-4154193d49c5"
}</pre>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section358155716277"><h4 class="sectiontitle">Example Response</h4><ul id="dataartsstudio_02_0058__en-us_topic_0181281350_ul849401320464"><li id="dataartsstudio_02_0058__en-us_topic_0181281350_li1530714111306">Success response<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p1430764112307"><a name="dataartsstudio_02_0058__en-us_topic_0181281350_li1530714111306"></a><a name="en-us_topic_0181281350_li1530714111306"></a>HTTP status code 200</p>
</li></ul>
<ul id="dataartsstudio_02_0058__en-us_topic_0181281350_ul4337895312"><li id="dataartsstudio_02_0058__en-us_topic_0181281350_li697361214553">Failure response<p id="dataartsstudio_02_0058__en-us_topic_0181281350_p89261205810"><a name="dataartsstudio_02_0058__en-us_topic_0181281350_li697361214553"></a><a name="en-us_topic_0181281350_li697361214553"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0058__en-us_topic_0181281350_screen681114215538">{
@ -131,6 +130,7 @@
"error_msg":"The script does not exist."
}</pre>
</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0058__en-us_topic_0181281350_section1353211420567"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0058__en-us_topic_0181281350_p143101838105620">See <a href="dataartsstudio_02_0310.html">Status Codes</a>.</p>
</div>
</div>
@ -140,3 +140,10 @@
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>

Some files were not shown because too many files have changed in this diff Show More