forked from docs/doc-exports
Li, Qiao
901ea67b42
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Li, Qiao <qiaoli@huawei.com> Co-committed-by: Li, Qiao <qiaoli@huawei.com>
35 lines
3.8 KiB
HTML
35 lines
3.8 KiB
HTML
<a name="waf_02_0001"></a><a name="waf_02_0001"></a>
|
|
|
|
<h1 class="topictitle1">API Usage Guidelines</h1>
|
|
<div id="body1545875653843"><p id="waf_02_0001__p1645204610259">Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: <em id="waf_02_0001__i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="waf_02_0001__b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
|
|
<p id="waf_02_0001__p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="waf_02_0001__b3082532510259">Application/json</strong>.</p>
|
|
<p id="waf_02_0001__p188289482118">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
|
|
<div class="notice" id="waf_02_0001__note1473213279256"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="waf_02_0001__p19733227172512">The following table lists the additional request header fields required for the POST, PUT, PATCH, and DELETE methods.</p>
|
|
</div></div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="waf_02_0001__tdfc57d5638cd437a9acf408b1c13641b" frame="border" border="1" rules="all"><thead align="left"><tr id="waf_02_0001__rb4195bd3ee6a44488c466d41c6644665"><th align="left" class="cellrowborder" valign="top" width="19.74%" id="mcps1.3.5.1.5.1.1"><p id="waf_02_0001__aa79becf302ca469483a0de48a9e06d19"><strong id="waf_02_0001__b1844753665617">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.490000000000002%" id="mcps1.3.5.1.5.1.2"><p id="waf_02_0001__abe266326263e4cc0af1bc6626a1d841b"><strong id="waf_02_0001__b6267183819560">Description</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.93%" id="mcps1.3.5.1.5.1.3"><p id="waf_02_0001__a8efc45469e5540f993b52578749436e1"><strong id="waf_02_0001__b432263945611">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.839999999999996%" id="mcps1.3.5.1.5.1.4"><p id="waf_02_0001__ac75836023a6343cb8d1a016b9b51f7a3">Example</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="waf_02_0001__r8c92183e5223419ea855f14b6948d3b7"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.5.1.5.1.1 "><p id="waf_02_0001__en-us_topic_0091607286_p46301737411">x-request-source-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.490000000000002%" headers="mcps1.3.5.1.5.1.2 "><p id="waf_02_0001__p1493958183511">Type of a request resource</p>
|
|
<ul id="waf_02_0001__ul1222313528312"><li id="waf_02_0001__li22256521633"><span class="parmvalue" id="waf_02_0001__parmvalue09731215134114"><b>ApiCall</b></span>: invoked by an API.</li><li id="waf_02_0001__li922719523317"><span class="parmvalue" id="waf_02_0001__parmvalue11910125204819"><b>ConsoleAction</b></span>: invoked by the console.</li><li id="waf_02_0001__li13807817371"><span class="parmvalue" id="waf_02_0001__parmvalue42931981491"><b>SystemAction</b></span>: invoked by the system.</li></ul>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.93%" headers="mcps1.3.5.1.5.1.3 "><p id="waf_02_0001__ae1d97a206af543fcaa349136e4bfbd52">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.839999999999996%" headers="mcps1.3.5.1.5.1.4 "><p id="waf_02_0001__a075a6640793e4cccb1629d7636e9189a">ApiCall</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|