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

DataArts API 20230329 version

Browse Source 
Reviewed-by: Kacur, Michal <michal.kacur@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
2023-06-29 16:21:21 +00:00
committed by zuul
parent e109bf9c8e
commit f2733178cc
166 changed files with 31392 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1382
docs/dataartsstudio/api-ref/ALL_META.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

1244
docs/dataartsstudio/api-ref/CLASS.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

882
docs/dataartsstudio/api-ref/CreateAndStartRandomClusterJob.html Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

639
docs/dataartsstudio/api-ref/CreateLink.html Normal file
View File

File diff suppressed because it is too large Load Diff

175
docs/dataartsstudio/api-ref/DeleteCluster.html Normal file
View File

File diff suppressed because it is too large Load Diff

159
docs/dataartsstudio/api-ref/DeleteJob.html Normal file
View File

File diff suppressed because it is too large Load Diff

164
docs/dataartsstudio/api-ref/DeleteLink.html Normal file
View File

File diff suppressed because it is too large Load Diff

21
docs/dataartsstudio/api-ref/ErrorCode.html Normal file
View File

@ -0,0 +1,21 @@
<a name="ErrorCode"></a><a name="ErrorCode"></a>
<h1 class="topictitle1">Error Codes</h1>
<div id="body0000001199085845"><p id="ErrorCode__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0311.html">CDM Error Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0313.html">DLF Error Codes</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0309.html">Appendix</a></div>
</div>
</div>

856
docs/dataartsstudio/api-ref/ListClusters.html Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/dataartsstudio/api-ref/PARAMETERS.txt Normal file
View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

256
docs/dataartsstudio/api-ref/RestartCluster.html Normal file
View File

File diff suppressed because it is too large Load Diff

1000
docs/dataartsstudio/api-ref/ShowClusterDetail.html Normal file
View File

File diff suppressed because it is too large Load Diff

393
docs/dataartsstudio/api-ref/ShowJobStatus.html Normal file
View File

File diff suppressed because it is too large Load Diff

690
docs/dataartsstudio/api-ref/ShowJobs.html Normal file
View File

File diff suppressed because it is too large Load Diff

407
docs/dataartsstudio/api-ref/ShowLink.html Normal file
View File

File diff suppressed because it is too large Load Diff

428
docs/dataartsstudio/api-ref/ShowSubmissions.html Normal file
View File

File diff suppressed because it is too large Load Diff

175
docs/dataartsstudio/api-ref/StartCluster.html Normal file
View File

File diff suppressed because it is too large Load Diff

264
docs/dataartsstudio/api-ref/StartJob.html Normal file
View File

File diff suppressed because it is too large Load Diff

213
docs/dataartsstudio/api-ref/StopCluster.html Normal file
View File

File diff suppressed because it is too large Load Diff

154
docs/dataartsstudio/api-ref/StopJob.html Normal file
View File

File diff suppressed because it is too large Load Diff

817
docs/dataartsstudio/api-ref/UpdateJob.html Normal file
View File

File diff suppressed because it is too large Load Diff

569
docs/dataartsstudio/api-ref/UpdateLink.html Normal file
View File

File diff suppressed because it is too large Load Diff

25
docs/dataartsstudio/api-ref/dataartsstudio_02_0001.html Normal file
View File

@ -0,0 +1,25 @@
<a name="dataartsstudio_02_0001"></a><a name="dataartsstudio_02_0001"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0002.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0003.html">API Calling</a></strong><br>
</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>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0314.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>
</div>

13
docs/dataartsstudio/api-ref/dataartsstudio_02_0002.html Normal file
View File

@ -0,0 +1,13 @@
<a name="dataartsstudio_02_0002"></a><a name="dataartsstudio_02_0002"></a>
<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>
</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>

11
docs/dataartsstudio/api-ref/dataartsstudio_02_0003.html Normal file
View File

@ -0,0 +1,11 @@
<a name="dataartsstudio_02_0003"></a><a name="dataartsstudio_02_0003"></a>
<h1 class="topictitle1">API Calling</h1>
<div id="body8662426"><p id="dataartsstudio_02_0003__en-us_topic_0181281283_en-us_topic_0170640574_en-us_topic_0170093944_p8060118"><span id="dataartsstudio_02_0003__text99955489282">DataArts Studio</span> supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details on API calling, see <a href="dataartsstudio_02_0008.html">Calling APIs</a>.</p>
</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>

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

@ -0,0 +1,13 @@
<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>

12
docs/dataartsstudio/api-ref/dataartsstudio_02_0005.html Normal file
View File

@ -0,0 +1,12 @@
<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>
</li><li id="dataartsstudio_02_0005__li4699188341">For the constraints of other modules' APIs, see their API descriptions.</li></ul>
</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>

16
docs/dataartsstudio/api-ref/dataartsstudio_02_0006.html Normal file
View File

@ -0,0 +1,16 @@
<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>
</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>
</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>
</li></ul>
</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>

196
docs/dataartsstudio/api-ref/dataartsstudio_02_0007.html Normal file
View File

File diff suppressed because it is too large Load Diff

15
docs/dataartsstudio/api-ref/dataartsstudio_02_0008.html Normal file
View File

@ -0,0 +1,15 @@
<a name="dataartsstudio_02_0008"></a><a name="dataartsstudio_02_0008"></a>
<h1 class="topictitle1">Calling APIs</h1>
<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>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0010.html">Authentication</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0011.html">Response</a></strong><br>
</li>
</ul>
</div>

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

File diff suppressed because it is too large Load Diff

58
docs/dataartsstudio/api-ref/dataartsstudio_02_0010.html Normal file
View File

@ -0,0 +1,58 @@
<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>
<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>
<pre class="screen" id="dataartsstudio_02_0010__screen1891571453115">{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "<em id="dataartsstudio_02_0010__i1274635725119"><strong id="dataartsstudio_02_0010__b841820569516">username</strong></em>",
"password": "<em id="dataartsstudio_02_0010__i144512185214"><strong id="dataartsstudio_02_0010__b283550105213">********</strong></em>",
"domain": {
"name": "<em id="dataartsstudio_02_0010__i1220191035315"><strong id="dataartsstudio_02_0010__b186363916535">domainname</strong></em>"
}
}
}
},
"scope": {
"project": {
"id": "<em id="dataartsstudio_02_0010__i12245175475720"><strong id="dataartsstudio_02_0010__b985218522578">xxxxxxxxxxxxxxxxxx</strong></em>"
}
}
}
}</pre>
<p id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_p9691122114266">After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs, for example, the API used to query a connection list. For example, if the token is <span class="parmvalue" id="dataartsstudio_02_0010__en-us_topic_0181281305_parmvalue986910577527"><b>ABCDEFJ....</b></span>, <span class="parmvalue" id="dataartsstudio_02_0010__en-us_topic_0181281305_parmvalue158694579527"><b>X-Auth-Token: ABCDEFJ....</b></span> can be added to a request as follows:</p>
<pre class="screen" id="dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_screen11189101154015">
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></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></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></div>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0008.html">Calling APIs</a></div>
</div>
</div>

39
docs/dataartsstudio/api-ref/dataartsstudio_02_0011.html Normal file
View File

@ -0,0 +1,39 @@
<a name="dataartsstudio_02_0011"></a><a name="dataartsstudio_02_0011"></a>
<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>
</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>
</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>
<p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p157041652367">The following is part of the response body for the API used to obtain a user token. The following describes part of the request body.</p>
<pre class="screen" id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_screen65818201917">{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
"password"
],
"catalog": [
{
"endpoints": [
{
"region_id": "xxxxxx",
...</pre>
<p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p127537375412">If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.</p>
<pre class="screen" id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_screen102091730125513">{
"error_msg": "The format of message is error",
"error_code": "AS.0001"
}</pre>
<p id="dataartsstudio_02_0011__en-us_topic_0181281379_en-us_topic_0170647351_en-us_topic_0170155703_p1589911464018">In the response body, <strong id="dataartsstudio_02_0011__en-us_topic_0181281379_b16141135863811">error_code</strong> is an error code, and <strong id="dataartsstudio_02_0011__en-us_topic_0181281379_b1814215589386">error_msg</strong> provides information about the error.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0008.html">Calling APIs</a></div>
</div>
</div>

14
docs/dataartsstudio/api-ref/dataartsstudio_02_0012.html Normal file
View File

@ -0,0 +1,14 @@
<a name="dataartsstudio_02_0012"></a><a name="dataartsstudio_02_0012"></a>
<h1 class="topictitle1">Application Cases</h1>
<div id="body1564733644266"><p id="dataartsstudio_02_0012__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0013.html">Application Example</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0015.html">Example of Using Data Development APIs</a></strong><br>
</li>
</ul>
</div>

489
docs/dataartsstudio/api-ref/dataartsstudio_02_0013.html Normal file
View File

File diff suppressed because it is too large Load Diff

36
docs/dataartsstudio/api-ref/dataartsstudio_02_0015.html Normal file
View File

@ -0,0 +1,36 @@
<a name="dataartsstudio_02_0015"></a><a name="dataartsstudio_02_0015"></a>
<h1 class="topictitle1">Example of Using Data Development 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>
</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",
"type":"Shell",
"content":"echo a",
"connectionName":"con"
}</pre>
</div>
<ul id="dataartsstudio_02_0015__ul6728519471"><li id="dataartsstudio_02_0015__li572151474"><strong id="dataartsstudio_02_0015__b519920553586">name</strong> indicates a custom script name, for example, <strong id="dataartsstudio_02_0015__b82051355205811">echoTimeShell</strong>.</li><li id="dataartsstudio_02_0015__li972155104714"><strong id="dataartsstudio_02_0015__b185168145594">type</strong> indicates the type of the script.</li><li id="dataartsstudio_02_0015__li138583764716"><strong id="dataartsstudio_02_0015__b18521285593">content</strong> indicates the script content.</li><li id="dataartsstudio_02_0015__li16721355473"><strong id="dataartsstudio_02_0015__b1924916444591">connectionName</strong> indicates the name of the data connection associated with the script.</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0015__section191731914114716"><h4 class="sectiontitle">Creating a DLI SQL Script</h4><div class="p" id="dataartsstudio_02_0015__p15173101410479">You can also create a DLI SQL script. The following is an example:<pre class="screen" id="dataartsstudio_02_0015__screen71731614184715">{
"name":"dlisql1",
"type":"DLISQL",
"content":"show tables",
"connectionName":"dliCon1",
"database":"testDatabase1",
"queueName":"queue1"
}</pre>
</div>
<ul id="dataartsstudio_02_0015__ul18173161415478"><li id="dataartsstudio_02_0015__li1540303194815"><strong id="dataartsstudio_02_0015__b1399318583594">name</strong> indicates a custom script name, for example, <strong id="dataartsstudio_02_0015__b799885885914">dlisql1</strong>.</li><li id="dataartsstudio_02_0015__li144031031204816"><strong id="dataartsstudio_02_0015__b9132172511592">type</strong> indicates the type of the script.</li><li id="dataartsstudio_02_0015__li34031631204814"><strong id="dataartsstudio_02_0015__b15895133225912">content</strong> indicates the script content.</li><li id="dataartsstudio_02_0015__li84032311485"><strong id="dataartsstudio_02_0015__b159719918011">connectionName</strong> indicates the name of the data connection associated with the script.</li><li id="dataartsstudio_02_0015__li7403131104810"><strong id="dataartsstudio_02_0015__b4347191511018">database</strong> indicates the name of the associated database when the script is executed.</li><li id="dataartsstudio_02_0015__li8403123117483"><strong id="dataartsstudio_02_0015__b77315281506">queueName</strong> indicates the name of the queue running on DLI when the SQL statement is executed.</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0012.html">Application Cases</a></div>
</div>
</div>

17
docs/dataartsstudio/api-ref/dataartsstudio_02_0016.html Normal file
View File

@ -0,0 +1,17 @@
<a name="dataartsstudio_02_0016"></a><a name="dataartsstudio_02_0016"></a>
<h1 class="topictitle1">DataArts Migration APIs</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="topic_300000000_3.html">Cluster Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000001_2.html">Job Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000002_2.html">Link Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0260.html">Public Data Structures</a></strong><br>
</li>
</ul>
</div>

25
docs/dataartsstudio/api-ref/dataartsstudio_02_0049.html Normal file
View File

@ -0,0 +1,25 @@
<a name="dataartsstudio_02_0049"></a><a name="dataartsstudio_02_0049"></a>
<h1 class="topictitle1">Connection Management APIs</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>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0051.html">Querying a Connection List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0052.html">Viewing Connection Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0053.html">Editing a Connection</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0054.html">Deleting a Connection</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0055.html">Exporting a Connection</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>
</div>

589
docs/dataartsstudio/api-ref/dataartsstudio_02_0050.html Normal file
View File

File diff suppressed because it is too large Load Diff

204
docs/dataartsstudio/api-ref/dataartsstudio_02_0051.html Normal file
View File

File diff suppressed because it is too large Load Diff

150
docs/dataartsstudio/api-ref/dataartsstudio_02_0052.html Normal file
View File

File diff suppressed because it is too large Load Diff

160
docs/dataartsstudio/api-ref/dataartsstudio_02_0053.html Normal file
View File

File diff suppressed because it is too large Load Diff

81
docs/dataartsstudio/api-ref/dataartsstudio_02_0054.html Normal file
View File

@ -0,0 +1,81 @@
<a name="dataartsstudio_02_0054"></a><a name="dataartsstudio_02_0054"></a>
<h1 class="topictitle1">Deleting a Connection</h1>
<div id="body0000001104494702"><div class="section" id="dataartsstudio_02_0054__en-us_topic_0181281367_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p1912913467404">This API is used to delete a connection.</p>
</div>
<div class="section" id="dataartsstudio_02_0054__en-us_topic_0181281367_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0054__en-us_topic_0181281367_ul145591424184717"><li id="dataartsstudio_02_0054__en-us_topic_0181281367_li356152404715">URI format<p id="dataartsstudio_02_0054__en-us_topic_0181281367_p076674419427"><a name="dataartsstudio_02_0054__en-us_topic_0181281367_li356152404715"></a><a name="en-us_topic_0181281367_li356152404715"></a>DELETE /v1/{project_id}/connections/{connection_name}</p>
</li></ul>
</div>
<ul id="dataartsstudio_02_0054__en-us_topic_0181281367_ul1370917277482"><li id="dataartsstudio_02_0054__en-us_topic_0181281367_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.43%" id="mcps1.3.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.03%" id="mcps1.3.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.24%" id="mcps1.3.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.300000000000004%" id="mcps1.3.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.43%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.03%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_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>
</tr>
<tr id="dataartsstudio_02_0054__en-us_topic_0181281367_row1490392211329"><td class="cellrowborder" valign="top" width="20.43%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p149041422193215">connection_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.03%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p290412226324">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.24%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p189045226328">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p1990462219327">Name of a connection.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="section" id="dataartsstudio_02_0054__en-us_topic_0181281367_section10789431145710"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0054__en-us_topic_0181281367_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_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_0054__en-us_topic_0181281367_en-us_topic_0181281363_p3149113112204">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_p13149173119204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_p1150183116205">workspace</p>
</td>
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_p4150531152016">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_p181505317209">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0054__b12881359228">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0054__en-us_topic_0181281367_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0054__en-us_topic_0181281367_section561243517589"><h4 class="sectiontitle">Response</h4><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p7541145513348">None.</p>
</div>
<div class="section" id="dataartsstudio_02_0054__en-us_topic_0181281367_section358155716277"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0054__en-us_topic_0181281367_p1488816432455">Delete the connection.</p>
<ul id="dataartsstudio_02_0054__en-us_topic_0181281367_ul18736591462"><li id="dataartsstudio_02_0054__en-us_topic_0181281367_li47367914616">Request<pre class="screen" id="dataartsstudio_02_0054__en-us_topic_0181281367_screen165211354306">DELETE /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/connection1</pre>
</li></ul>
</div>
<ul id="dataartsstudio_02_0054__en-us_topic_0181281367_ul13130223205017"><li id="dataartsstudio_02_0054__en-us_topic_0181281367_li149491320463">Success response<p id="dataartsstudio_02_0054__en-us_topic_0181281367_p107513409317"><a name="dataartsstudio_02_0054__en-us_topic_0181281367_li149491320463"></a><a name="en-us_topic_0181281367_li149491320463"></a>HTTP status code 204</p>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0049.html">Connection Management APIs</a></div>
</div>
</div>

85
docs/dataartsstudio/api-ref/dataartsstudio_02_0055.html Normal file
View File

@ -0,0 +1,85 @@
<a name="dataartsstudio_02_0055"></a><a name="dataartsstudio_02_0055"></a>
<h1 class="topictitle1">Exporting a Connection</h1>
<div id="body0000001151174551"><div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0055__en-us_topic_0181281331_p1912913467404">This API is used to export all connection information that is compressed in ZIP format.</p>
</div>
<div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0055__en-us_topic_0181281331_ul145591424184717"><li id="dataartsstudio_02_0055__en-us_topic_0181281331_li356152404715">URI format<p id="dataartsstudio_02_0055__en-us_topic_0181281331_p076674419427"><a name="dataartsstudio_02_0055__en-us_topic_0181281331_li356152404715"></a><a name="en-us_topic_0181281331_li356152404715"></a>POST /v1/{project_id}/connections/export</p>
</li></ul>
</div>
<ul id="dataartsstudio_02_0055__en-us_topic_0181281331_ul1370917277482"><li id="dataartsstudio_02_0055__en-us_topic_0181281331_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.66%" id="mcps1.3.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.12%" id="mcps1.3.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.169999999999995%" id="mcps1.3.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.66%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.169999999999995%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_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>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section10789431145710"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0055__en-us_topic_0181281331_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0055__en-us_topic_0181281331_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_0055__en-us_topic_0181281331_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_0055__en-us_topic_0181281331_en-us_topic_0181281363_p3149113112204">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p13149173119204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p1150183116205">workspace</p>
</td>
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p4150531152016">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p181505317209">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0055__b107001330684">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0055__en-us_topic_0181281331_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section561243517589"><h4 class="sectiontitle">Response</h4><p id="dataartsstudio_02_0055__en-us_topic_0181281331_p7541145513348">The value of <strong id="dataartsstudio_02_0055__en-us_topic_0181281331_b766312504384">Content-Type</strong> in the response message is <strong id="dataartsstudio_02_0055__en-us_topic_0181281331_b10636115818387">application/octet-stream</strong> that needs to be converted into a file. For details, see <a href="dataartsstudio_02_0317.html">Parsing a Stream in a Response Message</a>. Response messages are compressed as a file. The file name format is <strong id="dataartsstudio_02_0055__en-us_topic_0181281331_b115476032115">DLF_All_DataConnections.zip</strong>. The file directory is as follows:</p>
<pre class="screen" id="dataartsstudio_02_0055__en-us_topic_0181281331_screen10761137172910">connections
├─{dwsConnection}.conn</pre>
<p id="dataartsstudio_02_0055__en-us_topic_0181281331_p1229207392"></p>
</div>
<div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section358155716277"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0055__en-us_topic_0181281331_p1488816432455">Export a connection.</p>
<ul id="dataartsstudio_02_0055__en-us_topic_0181281331_ul18736591462"><li id="dataartsstudio_02_0055__en-us_topic_0181281331_li47367914616">Request<pre class="screen" id="dataartsstudio_02_0055__en-us_topic_0181281331_screen165211354306">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/connections/export</pre>
</li></ul>
</div>
<ul id="dataartsstudio_02_0055__en-us_topic_0181281331_ul13130223205017"><li id="dataartsstudio_02_0055__en-us_topic_0181281331_li149491320463">Success response<p id="dataartsstudio_02_0055__en-us_topic_0181281331_p107513409317"><a name="dataartsstudio_02_0055__en-us_topic_0181281331_li149491320463"></a><a name="en-us_topic_0181281331_li149491320463"></a>HTTP status code 200</p>
<pre class="screen" id="dataartsstudio_02_0055__en-us_topic_0181281331_screen134017453193">Response messages are compressed as a file. The file directory is as follows:
connections
├─{dwsConnection}.conn</pre>
</li><li id="dataartsstudio_02_0055__en-us_topic_0181281331_li697361214553">Failure response<p id="dataartsstudio_02_0055__en-us_topic_0181281331_p17868101111567"><a name="dataartsstudio_02_0055__en-us_topic_0181281331_li697361214553"></a><a name="en-us_topic_0181281331_li697361214553"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0055__en-us_topic_0181281331_screen31171971269">{
"error_code":"DLF.6322",
"error_msg":"The data connection does not exist."
}</pre>
</li></ul>
<div class="section" id="dataartsstudio_02_0055__en-us_topic_0181281331_section1623417185013"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0055__en-us_topic_0181281331_p285775634815">See <a href="dataartsstudio_02_0310.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0049.html">Connection Management APIs</a></div>
</div>
</div>

19
docs/dataartsstudio/api-ref/dataartsstudio_02_0056.html Normal file
View File

@ -0,0 +1,19 @@
<a name="dataartsstudio_02_0056"></a><a name="dataartsstudio_02_0056"></a>
<h1 class="topictitle1">Script Development APIs</h1>
<div id="body0000001151254645"></div>
<div>
<ul class="ullinks">
<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>
</li>
<li class="ulchildlink"><strong><a href="dataartsstudio_02_0059.html">Stopping Executing a Script Instance</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>
</div>

87
docs/dataartsstudio/api-ref/dataartsstudio_02_0057.html Normal file
View File

@ -0,0 +1,87 @@
<a name="dataartsstudio_02_0057"></a><a name="dataartsstudio_02_0057"></a>
<h1 class="topictitle1">Deleting a Script</h1>
<div id="body0000001104334888"><div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0057__en-us_topic_0181281364_p1912913467404">This API is used to delete a specific script.</p>
</div>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0057__en-us_topic_0181281364_ul145591424184717"><li id="dataartsstudio_02_0057__en-us_topic_0181281364_li356152404715">URI format<p id="dataartsstudio_02_0057__en-us_topic_0181281364_p076674419427"><a name="dataartsstudio_02_0057__en-us_topic_0181281364_li356152404715"></a><a name="en-us_topic_0181281364_li356152404715"></a>DELETE /v1/{project_id}/scripts/{script_name}</p>
</li></ul>
<ul id="dataartsstudio_02_0057__en-us_topic_0181281364_ul1370917277482"><li id="dataartsstudio_02_0057__en-us_topic_0181281364_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="19.919999999999998%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.530000000000001%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.24%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.31%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="19.919999999999998%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.530000000000001%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0093082049_p6820998181358">Yes</p>
</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>
</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>
</td>
<td class="cellrowborder" valign="top" width="10.530000000000001%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_p1195613271566">Yes</p>
</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_p421414825613">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_p395617274566">Script name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section10789431145710"><h4 class="sectiontitle">Request</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>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.3.2.2.5.1.3"><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_p13149173119204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.3.2.2.5.1.4"><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_p1150183116205">workspace</p>
</td>
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_p4150531152016">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_p181505317209">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0057__b725983913814">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0057__en-us_topic_0181281364_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section561243517589"><h4 class="sectiontitle">Response</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</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">{
"error_code":"DLF.6201",
"error_msg":"The script does not exist."
}</pre>
</li></ul>
</div>
<div class="section" id="dataartsstudio_02_0057__en-us_topic_0181281364_section1353211420567"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0057__en-us_topic_0181281364_p143101838105620">See <a href="dataartsstudio_02_0310.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0056.html">Script Development APIs</a></div>
</div>
</div>

142
docs/dataartsstudio/api-ref/dataartsstudio_02_0058.html Normal file
View File

File diff suppressed because it is too large Load Diff

96
docs/dataartsstudio/api-ref/dataartsstudio_02_0059.html Normal file
View File

@ -0,0 +1,96 @@
<a name="dataartsstudio_02_0059"></a><a name="dataartsstudio_02_0059"></a>
<h1 class="topictitle1">Stopping Executing a Script Instance</h1>
<div id="body0000001104814512"><div class="section" id="dataartsstudio_02_0059__en-us_topic_0181281376_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p1912913467404">This API is used to stop executing a script instance.</p>
</div>
<div class="section" id="dataartsstudio_02_0059__en-us_topic_0181281376_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0059__en-us_topic_0181281376_ul145591424184717"><li id="dataartsstudio_02_0059__en-us_topic_0181281376_li356152404715">URI format<p id="dataartsstudio_02_0059__en-us_topic_0181281376_p076674419427"><a name="dataartsstudio_02_0059__en-us_topic_0181281376_li356152404715"></a><a name="en-us_topic_0181281376_li356152404715"></a>POST /v1/{project_id}/scripts/{script_name}/instances/{instance_id}/stop</p>
</li></ul>
</div>
<ul id="dataartsstudio_02_0059__en-us_topic_0181281376_ul1370917277482"><li id="dataartsstudio_02_0059__en-us_topic_0181281376_li170972720484">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_p37484572181358">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.41%" id="mcps1.3.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_p16351468181358">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.12%" id="mcps1.3.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_p49400541181358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.42%" id="mcps1.3.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_p42020886181358">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_p15825795181358">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_p6820998181358">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0093082049_p15629937181358">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.42%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_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>
</tr>
<tr id="dataartsstudio_02_0059__en-us_topic_0181281376_row13119103205310"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p7120193212532">script_name</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p71207326534">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p19120183216531">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.42%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p17120133225310">Script name.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0059__en-us_topic_0181281376_row12416647175310"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p3416154795312">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="10.41%" headers="mcps1.3.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p124161247115310">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p15416174785313">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.42%" headers="mcps1.3.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p12416134712535">ID of the script instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<div class="section" id="dataartsstudio_02_0059__en-us_topic_0181281376_section10789431145710"><h4 class="sectiontitle">Request</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0059__en-us_topic_0181281376_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0059__en-us_topic_0181281376_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_0059__en-us_topic_0181281376_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_0059__en-us_topic_0181281376_en-us_topic_0181281363_p3149113112204">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_p13149173119204">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_p11149331122017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_p1150183116205">workspace</p>
</td>
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_p4150531152016">No</p>
</td>
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_p181505317209">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
<ul id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0059__b1193664011112">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0059__en-us_topic_0181281376_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dataartsstudio_02_0059__en-us_topic_0181281376_section561243517589"><h4 class="sectiontitle">Response</h4><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p1694061519142">None.</p>
</div>
<div class="section" id="dataartsstudio_02_0059__en-us_topic_0181281376_section358155716277"><h4 class="sectiontitle">Example</h4><ul id="dataartsstudio_02_0059__en-us_topic_0181281376_ul1469515810915"><li id="dataartsstudio_02_0059__en-us_topic_0181281376_li11695205817912">Request<pre class="screen" id="dataartsstudio_02_0059__en-us_topic_0181281376_screen1469510581692">POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/scripts/dwsscript/instances/a1ad-448a-9d56-4154193d49c5/stop</pre>
</li></ul>
</div>
<ul id="dataartsstudio_02_0059__en-us_topic_0181281376_ul849401320464"><li id="dataartsstudio_02_0059__en-us_topic_0181281376_li149491320463">Success response<p id="dataartsstudio_02_0059__en-us_topic_0181281376_p9630194718227"><a name="dataartsstudio_02_0059__en-us_topic_0181281376_li149491320463"></a><a name="en-us_topic_0181281376_li149491320463"></a>HTTP status code 204</p>
</li><li id="dataartsstudio_02_0059__en-us_topic_0181281376_li313082312504">Failure response<p id="dataartsstudio_02_0059__en-us_topic_0181281376_p17868101111567"><a name="dataartsstudio_02_0059__en-us_topic_0181281376_li313082312504"></a><a name="en-us_topic_0181281376_li313082312504"></a>HTTP status code 400</p>
<pre class="screen" id="dataartsstudio_02_0059__en-us_topic_0181281376_screen2818105917308">{
"error_code":"DLF.6205",
"error_msg":"The script running history does not exist."
}</pre>
</li></ul>
<div class="section" id="dataartsstudio_02_0059__en-us_topic_0181281376_section1353211420567"><h4 class="sectiontitle">Status Codes</h4><p id="dataartsstudio_02_0059__en-us_topic_0181281376_p143101838105620">See <a href="dataartsstudio_02_0310.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0056.html">Script Development APIs</a></div>
</div>
</div>

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