forked from docs/doc-exports
chenxiaoxiong
f9e2808b7c
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: chenxiaoxiong <chenxiaoxiong@huawei.com> Co-committed-by: chenxiaoxiong <chenxiaoxiong@huawei.com>
210 lines
26 KiB
HTML
210 lines
26 KiB
HTML
<a name="dataartsstudio_01_1620"></a><a name="dataartsstudio_01_1620"></a>
|
|
|
|
<h1 class="topictitle1">Rest Client Connection Parameters</h1>
|
|
<div id="body0000001707828793">
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_01_1620__table044061314236" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Rest Client connection</caption><thead align="left"><tr id="dataartsstudio_01_1620__row9441151311235"><th align="left" class="cellrowborder" valign="top" width="12.01120112011201%" id="mcps1.3.1.2.4.1.1"><p id="dataartsstudio_01_1620__p99076127279">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="7.970797079707969%" id="mcps1.3.1.2.4.1.2"><p id="dataartsstudio_01_1620__p3908191212720">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="80.01800180018002%" id="mcps1.3.1.2.4.1.3"><p id="dataartsstudio_01_1620__p18908512172713">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_01_1620__row108319218345"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p187882052124512">Data Connection Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p4788145294511">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p5788165212458">The value is fixed at <strong id="dataartsstudio_01_1620__b89281450717">Rest Client</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row47715414212"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p144391329155119">Name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p11439192910511">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p10487624232">Name of the data connection to create. Data connection names can contain a maximum of 100 characters. They can contain only letters, digits, underscores (_), and hyphens (-).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row06711446427"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p13242217913">Tag</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p125731351498">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><div class="p" id="dataartsstudio_01_1620__p128024352611">Attribute of the data connection to create. Tags make management easier.<div class="note" id="dataartsstudio_01_1620__en-us_topic_0000001554166437_note97121765158"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dataartsstudio_01_1620__en-us_topic_0000001554166437_p107124612153">The tag name can contain only letters, digits, and underscores (_) and cannot start with an underscore (_) or contain more than 100 characters.</p>
|
|
</div></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row776691464211"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p3995101183619">Applicable Modules</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p6995417369">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p2073718457537">Select the modules for which this connection is available. The connection can be used in the selected modules.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row1744093144210"><td class="cellrowborder" colspan="3" valign="top" headers="mcps1.3.1.2.4.1.1 mcps1.3.1.2.4.1.2 mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p944010354216"><strong id="dataartsstudio_01_1620__b202370461147">Basic and Network Connectivity Configuration</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row844181311232"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p18492134253818">Connection address prefix</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p144931442183813">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p84891632154811">This parameter is displayed when <strong id="dataartsstudio_01_1620__b75611582044">DataArts Migration</strong> is selected for <strong id="dataartsstudio_01_1620__b856118581149">Applicable Modules</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p98811924182317">Prefix of the connection address. This prefix is automatically added when an API is called during a job test or execution. HTTPS supports only TLS 1.2.</p>
|
|
<p id="dataartsstudio_01_1620__p1944111138232">Example: <strong id="dataartsstudio_01_1620__b8506881755">https://xxx.com/prefix</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row1915561014412"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p51551210164419">Default Header</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p0155171012443">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p48053592489">This parameter is displayed when <strong id="dataartsstudio_01_1620__b94148441959">DataArts Migration</strong> is selected for <strong id="dataartsstudio_01_1620__b18414164414511">Applicable Modules</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p1515541044410">It specifies the default header parameter. This header is carried when an API is called. Example: {"Content-Type":"application/json"}</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row123019114510"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__en-us_topic_0141836082_p43320271527">KMS Key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__en-us_topic_0141836082_p1833162715212">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><div class="p" id="dataartsstudio_01_1620__p4476133012514">KMS key used to encrypt and decrypt data source authentication information. Select a default or custom key.<div class="note" id="dataartsstudio_01_1620__en-us_topic_0000001554166437_note5782131311013"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="dataartsstudio_01_1620__en-us_topic_0000001554166437_ul15258512511"><li id="dataartsstudio_01_1620__en-us_topic_0000001554166437_li652514518257">When you use KMS for encryption through DataArts Studio or KPS for the first time, the default key <strong id="dataartsstudio_01_1620__en-us_topic_0000001554166437_b10282246320">dlf/default</strong> or <strong id="dataartsstudio_01_1620__en-us_topic_0000001554166437_b7601112203216">kps/default</strong> is automatically generated. For more information about default keys, see "What Is a Default Master Key?" in <em id="dataartsstudio_01_1620__en-us_topic_0000001554166437_i155895285215">Data Encryption Workshop FAQs</em>.</li><li id="dataartsstudio_01_1620__en-us_topic_0000001554166437_li694815818253">Only symmetric keys are supported. Asymmetric keys are not supported.</li></ul>
|
|
</div></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row7787119104518"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p778761917456">Agent</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p12787519154519">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p1380202114915">This parameter is displayed when <strong id="dataartsstudio_01_1620__b1928723013102">DataArts Migration</strong> is selected for <strong id="dataartsstudio_01_1620__b162881330171017">Applicable Modules</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p299985120498"><span id="dataartsstudio_01_1620__text215572916358">DataArts Studio</span> cannot directly connect to non-fully managed services. An agent is required for <span id="dataartsstudio_01_1620__text12155202953516">DataArts Studio</span> to communicate with non-fully managed services. A CDM cluster can function as an agent. If no CDM cluster is available, create one by referring to <a href="dataartsstudio_01_0576.html">Creating a CDM Cluster</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row067913545320"><td class="cellrowborder" colspan="3" valign="top" headers="mcps1.3.1.2.4.1.1 mcps1.3.1.2.4.1.2 mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p22501059165312"><strong id="dataartsstudio_01_1620__b2858123517128">Data Source Authentication and Other Function Configuration</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row114419134231"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p1749316428389">Rest auth type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p154931542193810">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p17814184410422">Authentication method. The following options are available:</p>
|
|
<ul id="dataartsstudio_01_1620__ul1581413442428"><li id="dataartsstudio_01_1620__li8814164454215"><strong id="dataartsstudio_01_1620__b1424918147135">NONE</strong>: no authentication</li><li id="dataartsstudio_01_1620__li11814144419427"><strong id="dataartsstudio_01_1620__b3615161611137">BASIC_AUTH</strong>: basic authentication<p id="dataartsstudio_01_1620__p1814174444212">If the data source API supports username and password authentication, you can select this authentication type and configure the username and password used for authentication. When the data source is connected, the username and password are transferred to the RESTful address through the Basic Auth protocol for authentication. The format is {"Authorization":"Basic base64(username:password)"}.</p>
|
|
</li><li id="dataartsstudio_01_1620__li1881418446427"><strong id="dataartsstudio_01_1620__b1581581861313">TOKEN_AUTH</strong>: token authentication (The token is static and never expires. Otherwise, jobs will fail if the token expires.)<p id="dataartsstudio_01_1620__p6814344144217">If the data source API supports token-based authentication, you can select this authentication type and set a fixed token for authentication. When the data source is connected, the token is transferred to the header for authentication. The format is {"Authorization":"Bearer <token>"}.</p>
|
|
</li><li id="dataartsstudio_01_1620__li1615586203517"><strong id="dataartsstudio_01_1620__b8119144301318">OAUTH_CODE_GRANT Oauth 2.0 (Authorization Code)</strong>: Oauth2.0 authentication<p id="dataartsstudio_01_1620__p107933109350">In this mode, a username and a password are used to obtain an access token, which is used to access APIs.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row19441191372316"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p1849354212382">Username</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p10493942103819">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p19392162165614">This parameter is displayed when <strong id="dataartsstudio_01_1620__b68556861510">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b1846102631517">BASIC_AUTH</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p49951334125514">You can use <strong id="dataartsstudio_01_1620__b18436539181520">#username</strong> to obtain the value and transfer it in the body and header.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row18441313172316"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p949354293816">Password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p9493194211384">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p6335103065618">This parameter is displayed when <strong id="dataartsstudio_01_1620__b9384145113151">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b183841151171519">BASIC_AUTH</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p164411913202317">You can use <strong id="dataartsstudio_01_1620__b175505341610">#password</strong> to obtain the value and transfer it in the body and header.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row1544181314237"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p2493154233811">Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p1049312429382">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p13683431573">This parameter is displayed when <strong id="dataartsstudio_01_1620__b16464162019163">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b346412071610">TOKEN_AUTH</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p1344141311234">You can use <strong id="dataartsstudio_01_1620__b78171342121713">#token</strong> to obtain the value and transfer it in the body and header.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row11884102820257"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p12493184213383">Auth request url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p1249310423381">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p6351143085710">This parameter is displayed when <strong id="dataartsstudio_01_1620__b2058117761819">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b758116714186">OAUTH_CODE_GRANT</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p167499133715">This parameter is available when <strong id="dataartsstudio_01_1620__b117741141176">Rest auth type</strong> is set to <strong id="dataartsstudio_01_1620__b27759381773">Oauth 2.0 (Authorization Code)</strong>. This API supports OAuth 2.0. Authentication credentials are used to obtain a token. Before testing connections and jobs, call this API to obtain the token. In addition, the location, name, and value acquisition mode of the token carried in subsequent APIs are defined in the authentication token.</p>
|
|
<p id="dataartsstudio_01_1620__p10158114114417">Example: <strong id="dataartsstudio_01_1620__b64415611129">https://xxx.com/auth/token</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row8885122872512"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p04931342143816">Auth request method</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p9493042113819">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p9729149214">This parameter is displayed when <strong id="dataartsstudio_01_1620__b114772915180">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b19147122981816">OAUTH_CODE_GRANT</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p98232293445">Authentication request method in OAuth 2.0 mode. The value can be <strong id="dataartsstudio_01_1620__b347991713146">GET</strong> or <strong id="dataartsstudio_01_1620__b569710215146">POST</strong>. This parameter is mandatory if <strong id="dataartsstudio_01_1620__b57481444161419">Auth request url</strong> is set.</p>
|
|
<p id="dataartsstudio_01_1620__p38236291442">Example: <strong id="dataartsstudio_01_1620__b14425105111411">GET</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row988582820254"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p19493194283814">Auth request username</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p4493942103817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p857017181616">This parameter is displayed when <strong id="dataartsstudio_01_1620__b1232016469183">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b12320134613186">OAUTH_CODE_GRANT</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p1580111251384">This parameter is mandatory for the Oauth 2.0 mode. You can use <strong id="dataartsstudio_01_1620__b435694271515">#authUsername</strong> to obtain the value of this parameter and enter it in the <strong id="dataartsstudio_01_1620__b133651247171620">authHeader</strong> or <strong id="dataartsstudio_01_1620__b23419213171">authbody</strong> parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row15885162862510"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p44941842163813">Auth request password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p749434220384">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p109875221113">This parameter is displayed when <strong id="dataartsstudio_01_1620__b17421988195">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b17429861913">OAUTH_CODE_GRANT</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p14885182872512">This parameter is mandatory for the Oauth 2.0 mode. You can use <strong id="dataartsstudio_01_1620__b174841437102">#authPassword</strong> to obtain the value of this parameter and enter it in the <strong id="dataartsstudio_01_1620__b17484164371012">authHeader</strong> or <strong id="dataartsstudio_01_1620__b3485134312101">authbody</strong> parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row148851228152519"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p1149494263819">Auth request header</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p174947423388">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p10902331920">This parameter is displayed when <strong id="dataartsstudio_01_1620__b394820102196">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b189481010141917">OAUTH_CODE_GRANT</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p19269264456">Request header for the Oauth 2.0 mode. The authentication account and password can be obtained through <strong id="dataartsstudio_01_1620__b1609165621918">#authUsername</strong> and <strong id="dataartsstudio_01_1620__b9591512112016">#authPassword</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p11269106124516">Example: {"username": "#authUsername","password": "#authPassword","Content-Type":"application/json"}</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row38851228142510"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p0494042173819">Auth request body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p1149413424381">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p10923173812216">This parameter is displayed when <strong id="dataartsstudio_01_1620__b5767512121918">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b1476721231918">OAUTH_CODE_GRANT</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p449745816451">Request body for the Oauth 2.0 mode. This parameter is unavailable when <strong id="dataartsstudio_01_1620__b672515062215">Auth request method</strong> is set to <strong id="dataartsstudio_01_1620__b161041188226">GET</strong>. The authentication account and password can be obtained through <strong id="dataartsstudio_01_1620__b2271113102116">#authUsername</strong> and <strong id="dataartsstudio_01_1620__b6271103119215">#authPassword</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p5497175884511">Example: <strong id="dataartsstudio_01_1620__b14490174711227">{"username": "#authUsername","password": "#authPassword"}</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row1888532811251"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p54941442163820">Auth request token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p64947422387">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p7575162711117">This parameter is displayed when <strong id="dataartsstudio_01_1620__b555911410190">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b956081412197">OAUTH_CODE_GRANT</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p1941972554619">Authentication token, which can be obtained from the response body of the authentication API and carried in the connection and job test. The token can only be placed in the header. The value contains a parameter name and a parameter value. The parameter value can be a SpEL expression.</p>
|
|
<p id="dataartsstudio_01_1620__p1242011253467">The following is an example:</p>
|
|
<p id="dataartsstudio_01_1620__p8420182513462">The authentication response body is as follows:</p>
|
|
<p id="dataartsstudio_01_1620__p134202259468">{</p>
|
|
<p id="dataartsstudio_01_1620__p1642052544619">"code" : 200,</p>
|
|
<p id="dataartsstudio_01_1620__p1242082514614">"data" : {</p>
|
|
<p id="dataartsstudio_01_1620__p74201725174620">"access_token" : "DSFSDFWE87WE9089W9EW9ER898WER9W89ER8",</p>
|
|
<p id="dataartsstudio_01_1620__p142002534615">"expired":1000</p>
|
|
<p id="dataartsstudio_01_1620__p1642012564614">}</p>
|
|
<p id="dataartsstudio_01_1620__p144203259468">}</p>
|
|
<p id="dataartsstudio_01_1620__p94202254464">To obtain the value of <strong id="dataartsstudio_01_1620__b1997122681113">access_token</strong> in Bearer <token> format, set the value of this parameter as follows:</p>
|
|
<p id="dataartsstudio_01_1620__p64201125144611"><strong id="dataartsstudio_01_1620__b12745465297">NAME: Authentication</strong></p>
|
|
<p id="dataartsstudio_01_1620__p14201325134612"><strong id="dataartsstudio_01_1620__b1030410952913">VALUE: 'Bearer ' + #response.data.access_token</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_01_1620__row014523802516"><td class="cellrowborder" valign="top" width="12.01120112011201%" headers="mcps1.3.1.2.4.1.1 "><p id="dataartsstudio_01_1620__p11494442193815">Auth request token expired</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.970797079707969%" headers="mcps1.3.1.2.4.1.2 "><p id="dataartsstudio_01_1620__p20494442183815">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="80.01800180018002%" headers="mcps1.3.1.2.4.1.3 "><p id="dataartsstudio_01_1620__p15898173418113">This parameter is displayed when <strong id="dataartsstudio_01_1620__b5370181671912">Rest auth type</strong> is <strong id="dataartsstudio_01_1620__b1637081613193">OAUTH_CODE_GRANT</strong>.</p>
|
|
<p id="dataartsstudio_01_1620__p663743824613">Validity period of the authentication token, in seconds. The value can be an EL expression. The default value <strong id="dataartsstudio_01_1620__b17257202033318">0</strong> indicates that the token is permanently valid.</p>
|
|
<p id="dataartsstudio_01_1620__p763716388462">Example 1: <strong id="dataartsstudio_01_1620__b122662671919">300</strong> indicates that the validity period is 300 seconds.</p>
|
|
<p id="dataartsstudio_01_1620__p2063783813462">Example 2: <strong id="dataartsstudio_01_1620__b949792213345">#response.data.expired</strong>. Obtain the value of the <strong id="dataartsstudio_01_1620__b398141810361">expired</strong> attribute from the JSON string returned by the authentication API. The default unit is second. If the value is not of the int type, enter a validity period.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_01_0009.html">Configuring DataArts Studio Data Connection Parameters</a></div>
|
|
</div>
|
|
</div>
|
|
|