forked from docs/doc-exports
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>
128 lines
12 KiB
HTML
128 lines
12 KiB
HTML
<a name="dataartsstudio_02_0082"></a><a name="dataartsstudio_02_0082"></a>
|
|
|
|
<h1 class="topictitle1">Data Structure</h1>
|
|
<div id="body0000001104654692"><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p1416130195814"><a href="#dataartsstudio_02_0082__en-us_topic_0181281357_table57965835161145">Table 1</a> describes common request headers.</p>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_02_0082__en-us_topic_0181281357_table57965835161145"></a><a name="en-us_topic_0181281357_table57965835161145"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0082__en-us_topic_0181281357_table57965835161145" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Common request header fields</caption><thead align="left"><tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row52836241161145"><th align="left" class="cellrowborder" valign="top" width="21.78%" id="mcps1.3.2.2.5.1.1"><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p64240732161145">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.94%" id="mcps1.3.2.2.5.1.2"><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p31315992153329">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.09%" id="mcps1.3.2.2.5.1.3"><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p57712042153910">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.190000000000005%" id="mcps1.3.2.2.5.1.4"><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p36116790161145">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row7787133161145"><td class="cellrowborder" valign="top" width="21.78%" headers="mcps1.3.2.2.5.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p26778032161145">X-Sdk-Date</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.94%" headers="mcps1.3.2.2.5.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p43997279153329">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.09%" headers="mcps1.3.2.2.5.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p52257880153929">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.190000000000005%" headers="mcps1.3.2.2.5.1.4 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p18043674161431">Time when the request is sent. The time is in <strong id="dataartsstudio_02_0082__en-us_topic_0181281357_b7397717868">YYYYMMDD'T'HHMMSS'Z'</strong> format.</p>
|
|
<p id="dataartsstudio_02_0082__en-us_topic_0181281357_p28175340161431">The value is the current GMT time of the system.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row24882685161145"><td class="cellrowborder" valign="top" width="21.78%" headers="mcps1.3.2.2.5.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p2231611161145">Authorization</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.94%" headers="mcps1.3.2.2.5.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p63088480153329">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.09%" headers="mcps1.3.2.2.5.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p45268656153929">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.190000000000005%" headers="mcps1.3.2.2.5.1.4 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p28573427161440">Authentication information.</p>
|
|
<p id="dataartsstudio_02_0082__en-us_topic_0181281357_p55834259161440">The value can be obtained from the request signing result.</p>
|
|
<p id="dataartsstudio_02_0082__en-us_topic_0181281357_p32746288161440">For details, see <a href="dataartsstudio_02_0010.html#dataartsstudio_02_0010__en-us_topic_0181281305_en-us_topic_0170647350_en-us_topic_0121671869_section5887143815518">AK/SK-based Authentication</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row66131435161145"><td class="cellrowborder" valign="top" width="21.78%" headers="mcps1.3.2.2.5.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p55046047161145">Host</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.94%" headers="mcps1.3.2.2.5.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p21930696153329">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.09%" headers="mcps1.3.2.2.5.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p50398149153929">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.190000000000005%" headers="mcps1.3.2.2.5.1.4 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p29544823161145">Server information of the resource being requested. The value can be obtained from the URL of the service API. The value is in the format of <em id="dataartsstudio_02_0082__en-us_topic_0181281357_en-us_topic_0170647348_en-us_topic_0121682347_i1012185414574">hostname:port</em>. If the port number is not specified, the default port is used. The default port number for HTTPS is 443.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row30263649161145"><td class="cellrowborder" valign="top" width="21.78%" headers="mcps1.3.2.2.5.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p35436484161145">Content-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.94%" headers="mcps1.3.2.2.5.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p15568129153329">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.09%" headers="mcps1.3.2.2.5.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p31702378153929">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.190000000000005%" headers="mcps1.3.2.2.5.1.4 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p51782927161145">Request body MIME type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row48918398161145"><td class="cellrowborder" valign="top" width="21.78%" headers="mcps1.3.2.2.5.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p2967322161145">Content-Length</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.94%" headers="mcps1.3.2.2.5.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p7768254153329">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.09%" headers="mcps1.3.2.2.5.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p20932132153910">Int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.190000000000005%" headers="mcps1.3.2.2.5.1.4 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p39026563161145">Size of the request body, measured in bytes.</p>
|
|
<p id="dataartsstudio_02_0082__en-us_topic_0181281357_p1409196154235">Mandatory for POST and PUT requests, but must be left blank for GET requests.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row65161023114529"><td class="cellrowborder" valign="top" width="21.78%" headers="mcps1.3.2.2.5.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p56830897114537">X-Project-Id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.94%" headers="mcps1.3.2.2.5.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p39899921114537">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.09%" headers="mcps1.3.2.2.5.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p10668178114537">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.190000000000005%" headers="mcps1.3.2.2.5.1.4 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p58816091114537">Project ID used to obtain a token for each project.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row34820535114534"><td class="cellrowborder" valign="top" width="21.78%" headers="mcps1.3.2.2.5.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p61475780114537">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.94%" headers="mcps1.3.2.2.5.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p13482282114537">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.09%" headers="mcps1.3.2.2.5.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p30689526114537">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.190000000000005%" headers="mcps1.3.2.2.5.1.4 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p2823682114537">User token.</p>
|
|
<p id="dataartsstudio_02_0082__en-us_topic_0181281357_p3552727311469">This parameter is mandatory for authentication using tokens.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="dataartsstudio_02_0082__en-us_topic_0181281357_p167004409550"><a href="#dataartsstudio_02_0082__en-us_topic_0181281357_table27956731162223">Table 2</a> describes common response headers.</p>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_02_0082__en-us_topic_0181281357_table27956731162223"></a><a name="en-us_topic_0181281357_table27956731162223"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0082__en-us_topic_0181281357_table27956731162223" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Common response headers</caption><thead align="left"><tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row55068810162223"><th align="left" class="cellrowborder" valign="top" width="26.99%" id="mcps1.3.4.2.4.1.1"><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p14062480162223">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.169999999999998%" id="mcps1.3.4.2.4.1.2"><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p43928766154614">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.839999999999996%" id="mcps1.3.4.2.4.1.3"><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p65319062162223">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row51000650162223"><td class="cellrowborder" valign="top" width="26.99%" headers="mcps1.3.4.2.4.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p37411976162223">Content-Length</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.4.2.4.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p1460256154614">Int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.839999999999996%" headers="mcps1.3.4.2.4.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p10471219162223">Length of the response body. The unit is byte.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row27132108162223"><td class="cellrowborder" valign="top" width="26.99%" headers="mcps1.3.4.2.4.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p50217157162223">Date</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.4.2.4.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p4497506154632">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.839999999999996%" headers="mcps1.3.4.2.4.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p41057886162223">Time when a response is returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0082__en-us_topic_0181281357_row33976654162223"><td class="cellrowborder" valign="top" width="26.99%" headers="mcps1.3.4.2.4.1.1 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p645562162223">Content-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.4.2.4.1.2 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p57456722154632">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.839999999999996%" headers="mcps1.3.4.2.4.1.3 "><p id="dataartsstudio_02_0082__en-us_topic_0181281357_p52290587162223">Request body MIME type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0127.html">DataArts Factory APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|