doc-exports/docs/plas/api-ref/en-us_topic_0218811262.html
Mei, Sai 46435e6aee PLAS API version1
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Mei, Sai <meisai@huawei.com>
Co-committed-by: Mei, Sai <meisai@huawei.com>
2022-11-29 13:00:08 +00:00

99 lines
7.7 KiB
HTML

<a name="en-us_topic_0218811262"></a><a name="en-us_topic_0218811262"></a>
<h1 class="topictitle1">Common Request Headers</h1>
<div id="body4883512">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811262__table8544631" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Common request headers</caption><thead align="left"><tr id="en-us_topic_0218811262__row48651131"><th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.1.2.5.1.1"><p id="en-us_topic_0218811262__p48427543">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.77%" id="mcps1.3.1.2.5.1.2"><p id="en-us_topic_0218811262__p30316907">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.59%" id="mcps1.3.1.2.5.1.3"><p id="en-us_topic_0218811262__p39750432">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34.02%" id="mcps1.3.1.2.5.1.4"><p id="en-us_topic_0218811262__p65668446">Example Value</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811262__row17543884"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p11768466">x-sdk-date</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p13721689">Time when the request is sent. The time is in <strong id="en-us_topic_0218811262__b56386340">YYYYMMDD'T'HHMMSS'Z'</strong> format.</p>
<p id="en-us_topic_0218811262__p37715016">The value is the current GMT time of the system.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p35017480">No</p>
<p id="en-us_topic_0218811262__p46721870">This parameter is mandatory for AK/SK authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p26375114">20150907T101459Z</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row36049434"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p34323003">Authorization</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p28699853">Authentication information.</p>
<p id="en-us_topic_0218811262__p56972087">The value can be obtained from the request signing result.</p>
<p id="en-us_topic_0218811262__p16953871446">For details, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328006.html" target="_blank" rel="noopener noreferrer">Signing a Request</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p64605559">No</p>
<p id="en-us_topic_0218811262__p44579126">This parameter is mandatory for AK/SK authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p54139417">SDK-HMAC-SHA256 Credential=ZIRRKMTWPTQFQI1WKNKB/20150907//ec2/sdk_request, SignedHeaders=content-type;host;x-sdk-date, Signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row17492713"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p7623657">Host</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p13536461">Server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is <em id="en-us_topic_0218811262__i54719288">hostname[:port]</em>. If the port number is not specified, the default port is used. The default port number for <strong id="en-us_topic_0218811262__b22711550">https</strong> is <strong id="en-us_topic_0218811262__b3077358">443</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p47939452">No</p>
<p id="en-us_topic_0218811262__p28801892">This parameter is mandatory for AK/SK authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p51251947">code.test.com</p>
<p id="en-us_topic_0218811262__p58614339">or</p>
<p id="en-us_topic_0218811262__p57767005">code.test.com:443</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row50141003"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p34889419">Content-type</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p7470700">Request body MIME type.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p1146965">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p25795375">application/json</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row30831790"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p14347060">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p21261182">Length of the request body, expressed in bytes.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p44434164">This parameter is mandatory for POST and PUT requests but must be left blank for GET requests.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p42397568">3495</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row46033792"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p37749701">X-Project-Id</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p37826963">Project ID. This parameter is used to obtain the token for the project.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p44085137">No</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p14126311">e9993fc787d94b6c886cbaa340f9c0f4</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row60027939"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p30424881">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p48496300">User token.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p35886203">Yes</p>
<p id="en-us_topic_0218811262__p54540374">This parameter is mandatory for token authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p55694143">None</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="en-us_topic_0218811262__note41431923"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="en-us_topic_0218811262__p30218124">For details about other parameters in the message header, see the HTTP protocol documentation.</p>
</div></div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0218811261.html">Common Message Headers</a></div>
</div>
</div>