forked from docs/doc-exports
Reviewed-by: Ziuzko, Stanislav <stanislav.ziuzko@t-systems.com> Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com> Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
10 lines
1.8 KiB
HTML
10 lines
1.8 KiB
HTML
<a name="EN-US_TOPIC_0000001409488734"></a><a name="EN-US_TOPIC_0000001409488734"></a>
|
|
|
|
<h1 class="topictitle1">API Usage Guidelines</h1>
|
|
<div id="body0000001409488734"><p id="EN-US_TOPIC_0000001409488734__en-us_topic_0175303967_p7933938392">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: https://<em id="EN-US_TOPIC_0000001409488734__en-us_topic_0175303967_i193313381196">Endpoint/uri</em>. In the URL, <em id="EN-US_TOPIC_0000001409488734__en-us_topic_0175303967_i193311389910">uri</em> indicates the resource path, that is, the API access path.</p>
|
|
<p id="EN-US_TOPIC_0000001409488734__en-us_topic_0175303967_p39330381094">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by <strong id="EN-US_TOPIC_0000001409488734__en-us_topic_0175303967_b49339387910">Application/json</strong>.</p>
|
|
<p id="EN-US_TOPIC_0000001409488734__en-us_topic_0175303967_p139331638999">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" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
|
|
<p id="EN-US_TOPIC_0000001409488734__p1885314354417">For details about <span style="color:#212121;">metric description</span>, see <strong style="color:#212121;" id="EN-US_TOPIC_0000001409488734__b16238122018164">Metric Overview</strong><span style="color:#212121;"> in the </span><em style="color:#212121;" id="EN-US_TOPIC_0000001409488734__i96512314437">AOM User Guide</em><span style="color:#212121;">.</span></p>
|
|
</div>
|
|
|