doc-exports/docs/opengauss/api-ref/opengauss_api_0012.html
Ru, Li Yi d97aea4dd2 opengauss_api
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-09-06 09:04:21 +00:00

9 lines
1.3 KiB
HTML

<a name="EN-US_TOPIC_0000001917130760"></a><a name="EN-US_TOPIC_0000001917130760"></a>
<h1 class="topictitle1">Using APIs</h1>
<div id="body1600411288656"><p id="EN-US_TOPIC_0000001917130760__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="EN-US_TOPIC_0000001917130760__i204914796115410">https://Endpoint/uri</em>. In the URL, <em id="EN-US_TOPIC_0000001917130760__i842352697154116">uri</em> indicates the resource path, that is, the API access path.</p>
<p id="EN-US_TOPIC_0000001917130760__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="EN-US_TOPIC_0000001917130760__b1025950229154127">Application/json</strong>.</p>
<p id="EN-US_TOPIC_0000001917130760__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>