dli_api_0511_version

Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
This commit is contained in:
Su, Xiaomeng 2023-05-20 10:26:16 +00:00 committed by zuul
parent f701254745
commit f5d48a5472
26 changed files with 618 additions and 494 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,35 +0,0 @@
<a name="dli_02_0017"></a><a name="dli_02_0017"></a>
<h1 class="topictitle1">Job-related APIs</h1>
<div id="body8662426"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dli_02_0019.html">Importing Data</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0020.html">Exporting Data</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0102.html">Submitting a SQL Job (Recommended)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0104.html">Canceling a Job (Recommended)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0025.html">Querying All Jobs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0312.html">Previewing SQL Job Query Results</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0021.html">Querying Job Status</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0022.html">Querying Job Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0107.html">Checking SQL Syntax</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0024.html">Exporting Query Results</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0296.html">Querying the Job Execution Progress</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">APIs Related to SQL Jobs</a></div>
</div>
</div>

View File

@ -415,7 +415,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0031.html">Table-related APIs</a></div>
</div>
</div>

View File

@ -221,7 +221,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0031.html">Table-related APIs</a></div>
</div>
</div>

View File

@ -313,7 +313,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job related APIs</a></div>
</div>
</div>

View File

@ -329,7 +329,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job related APIs</a></div>
</div>
</div>

View File

@ -229,7 +229,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job related APIs</a></div>
</div>
</div>

View File

@ -500,7 +500,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job related APIs</a></div>
</div>
</div>

View File

@ -15,7 +15,7 @@
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">APIs Related to SQL Jobs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0356.html">Resource-related APIs</a></div>
</div>
</div>

View File

@ -8,6 +8,10 @@
</li>
<li class="ulchildlink"><strong><a href="dli_02_0035.html">Deleting a Table</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0019.html">Importing Data</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0020.html">Exporting Data</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0105.html">Querying All Tables (Recommended)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0033.html">Describing the Table Information</a></strong><br>
@ -19,7 +23,7 @@
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">APIs Related to SQL Jobs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0356.html">Resource-related APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -359,7 +359,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job related APIs</a></div>
</div>
</div>

View File

@ -112,7 +112,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job related APIs</a></div>
</div>
</div>

View File

@ -149,7 +149,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job related APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -1,15 +1,30 @@
<a name="dli_02_0158"></a><a name="dli_02_0158"></a>
<h1 class="topictitle1">APIs Related to SQL Jobs</h1>
<div id="body1547113207222"><p id="dli_02_0158__p8060118"></p>
<h1 class="topictitle1">SQL Job related APIs</h1>
<div id="body1547113207222"><p id="dli_02_0158__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dli_02_0027.html">Database-related APIs</a></strong><br>
<li class="ulchildlink"><strong><a href="dli_02_0102.html">Submitting a SQL Job (Recommended)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0031.html">Table-related APIs</a></strong><br>
<li class="ulchildlink"><strong><a href="dli_02_0104.html">Canceling a Job (Recommended)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0017.html">Job-related APIs</a></strong><br>
<li class="ulchildlink"><strong><a href="dli_02_0025.html">Querying All Jobs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0312.html">Previewing SQL Job Query Results</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0021.html">Querying Job Status</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0022.html">Querying Job Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0107.html">Checking SQL Syntax</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0024.html">Exporting Query Results</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0296.html">Querying the Job Execution Progress</a></strong><br>
</li>
</ul>
</div>

View File

@ -21,5 +21,9 @@
<li class="ulchildlink"><strong><a href="dli_02_0253.html">Changing the Owner of a Group or Resource Package</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0356.html">Resource-related APIs</a></div>
</div>
</div>

View File

@ -47,7 +47,7 @@
</tr>
<tr id="dli_02_0181__row11996916275"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="dli_02_0181__p99961416375">Job-related APIs</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.2 "><p id="dli_02_0181__p169961916475">You can import and export data, submitting SQL jobs, canceling jobs, querying all jobs, previewing job results, querying job status, querying job details, checking SQL syntax, and exporting query results.</p>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.2 "><p id="dli_02_0181__p169961916475">You can import and export data, submit SQL jobs, cancel jobs, query all jobs, preview job results, query job status, query job details, check SQL syntax, and export query results.</p>
</td>
</tr>
<tr id="dli_02_0181__row2560114991914"><td class="cellrowborder" valign="top" width="18.98%" headers="mcps1.3.2.2.4.1.1 "><p id="dli_02_0181__p1856119494193">Package Group-related APIs</p>
@ -89,10 +89,9 @@
</td>
<td class="cellrowborder" valign="top" width="16.18%" headers="mcps1.3.2.2.4.1.2 "><p id="dli_02_0181__p208487110215">-</p>
</td>
<td class="cellrowborder" valign="top" width="64.84%" headers="mcps1.3.2.2.4.1.3 "><p id="dli_02_0181__p18848918212">You can creat, delete, modify, and query global variables.</p>
<td class="cellrowborder" valign="top" width="64.84%" headers="mcps1.3.2.2.4.1.3 "><p id="dli_02_0181__p18848918212">You can create, delete, modify, and query global variables.</p>
</td>
</tr>
</tbody>
</table>
</div>

View File

@ -269,6 +269,65 @@
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0189__table1361042413311" frame="border" border="1" rules="all"><caption><b>Table 6 </b><strong id="dli_02_0189__b10484923142419">elastic_resource_pools</strong> parameters</caption><thead align="left"><tr id="dli_02_0189__row8611152423317"><th align="left" class="cellrowborder" valign="top" width="14.27%" id="mcps1.3.4.6.2.5.1.1"><p id="dli_02_0189__p158084353513">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.21%" id="mcps1.3.4.6.2.5.1.2"><p id="dli_02_0189__p12808738352">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.569999999999997%" id="mcps1.3.4.6.2.5.1.3"><p id="dli_02_0189__p1080853113517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.95%" id="mcps1.3.4.6.2.5.1.4"><p id="dli_02_0189__p0808193163510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0189__row36111524153320"><td class="cellrowborder" valign="top" width="14.27%" headers="mcps1.3.4.6.2.5.1.1 "><p id="dli_02_0189__p1280813333518">peer_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.3.4.6.2.5.1.2 "><p id="dli_02_0189__p1680810314352">No</p>
</td>
<td class="cellrowborder" valign="top" width="25.569999999999997%" headers="mcps1.3.4.6.2.5.1.3 "><p id="dli_02_0189__p8808134354">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.95%" headers="mcps1.3.4.6.2.5.1.4 "><p id="dli_02_0189__p180812318359">ID of a datasource connection.</p>
</td>
</tr>
<tr id="dli_02_0189__row1761114242333"><td class="cellrowborder" valign="top" width="14.27%" headers="mcps1.3.4.6.2.5.1.1 "><p id="dli_02_0189__p8808143153512">status</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.3.4.6.2.5.1.2 "><p id="dli_02_0189__p128086314356">No</p>
</td>
<td class="cellrowborder" valign="top" width="25.569999999999997%" headers="mcps1.3.4.6.2.5.1.3 "><p id="dli_02_0189__p188081037351">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.95%" headers="mcps1.3.4.6.2.5.1.4 "><p id="dli_02_0189__p1780810363514">Connection status. For details about the status code, see <a href="#dli_02_0189__table13946174752513">Table 5</a>.</p>
</td>
</tr>
<tr id="dli_02_0189__row11612132414331"><td class="cellrowborder" valign="top" width="14.27%" headers="mcps1.3.4.6.2.5.1.1 "><p id="dli_02_0189__p118091835351">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.3.4.6.2.5.1.2 "><p id="dli_02_0189__p480918373516">No</p>
</td>
<td class="cellrowborder" valign="top" width="25.569999999999997%" headers="mcps1.3.4.6.2.5.1.3 "><p id="dli_02_0189__p15809173183510">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.95%" headers="mcps1.3.4.6.2.5.1.4 "><p id="dli_02_0189__p2809230357">Elastic resource pool name</p>
</td>
</tr>
<tr id="dli_02_0189__row8612142414332"><td class="cellrowborder" valign="top" width="14.27%" headers="mcps1.3.4.6.2.5.1.1 "><p id="dli_02_0189__p68095313510">err_msg</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.3.4.6.2.5.1.2 "><p id="dli_02_0189__p138091133355">No</p>
</td>
<td class="cellrowborder" valign="top" width="25.569999999999997%" headers="mcps1.3.4.6.2.5.1.3 "><p id="dli_02_0189__p1809123143513">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.95%" headers="mcps1.3.4.6.2.5.1.4 "><p id="dli_02_0189__p3809173153516">Detailed error message when the status is <strong id="dli_02_0189__b835953102">FAILED</strong>.</p>
</td>
</tr>
<tr id="dli_02_0189__row1961242463317"><td class="cellrowborder" valign="top" width="14.27%" headers="mcps1.3.4.6.2.5.1.1 "><p id="dli_02_0189__p1380916320352">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="15.21%" headers="mcps1.3.4.6.2.5.1.2 "><p id="dli_02_0189__p178091838354">No</p>
</td>
<td class="cellrowborder" valign="top" width="25.569999999999997%" headers="mcps1.3.4.6.2.5.1.3 "><p id="dli_02_0189__p780911333511">Long</p>
</td>
<td class="cellrowborder" valign="top" width="44.95%" headers="mcps1.3.4.6.2.5.1.4 "><p id="dli_02_0189__p128091534358">Update time</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0189__section1217010661112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0189__p6101181617111">None</p>
</div>
@ -302,9 +361,9 @@
]
}</pre>
</div>
<div class="section" id="dli_02_0189__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0189__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0189__tb12870f1c5f24b27abd55ca24264af36">Table 6</a> describes the status code.</p>
<div class="section" id="dli_02_0189__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0189__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0189__tb12870f1c5f24b27abd55ca24264af36">Table 7</a> describes the status code.</p>
<div class="tablenoborder"><a name="dli_02_0189__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0189__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status codes</caption><thead align="left"><tr id="dli_02_0189__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0189__ab49d21f312644072a331f43e92baf853">Status Code</p>
<div class="tablenoborder"><a name="dli_02_0189__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0189__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Status codes</caption><thead align="left"><tr id="dli_02_0189__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0189__ab49d21f312644072a331f43e92baf853">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0189__aea1d3bd107bb4c499da79a88832d256c">Description</p>
</th>

View File

@ -51,13 +51,22 @@
</thead>
<tbody><tr id="dli_02_0191__row7654203716810"><td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0191__p15107358183">queues</p>
</td>
<td class="cellrowborder" valign="top" width="13.77137713771377%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0191__p8107558589">Yes</p>
<td class="cellrowborder" valign="top" width="13.77137713771377%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0191__p8107558589">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.49124912491249%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0191__p14937126595">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="55.84558455845584%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0191__p181078586810">List of queue names that are available for datasource connections.</p>
</td>
</tr>
<tr id="dli_02_0191__row66701842122315"><td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0191__p110715513215">elastic_resource_pools</p>
</td>
<td class="cellrowborder" valign="top" width="13.77137713771377%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0191__p1010710511213">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.49124912491249%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0191__p1110745182112">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="55.84558455845584%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0191__p3107552214">Elastic resource pools you want to bind to the enhanced datasource connection.</p>
</td>
</tr>
</tbody>
</table>
</div>

View File

@ -51,13 +51,22 @@
</thead>
<tbody><tr id="dli_02_0192__row7654203716810"><td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0192__p15107358183">queues</p>
</td>
<td class="cellrowborder" valign="top" width="13.77137713771377%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0192__p8107558589">Yes</p>
<td class="cellrowborder" valign="top" width="13.77137713771377%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0192__p8107558589">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.49124912491249%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0192__p14937126595">Array of String</p>
</td>
<td class="cellrowborder" valign="top" width="55.84558455845584%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0192__p181078586810">List of queue names that are available for datasource connections.</p>
</td>
</tr>
<tr id="dli_02_0192__row3324134615258"><td class="cellrowborder" valign="top" width="17.89178917891789%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0192__p110715513215">elastic_resource_pools</p>
</td>
<td class="cellrowborder" valign="top" width="13.77137713771377%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0192__p1010710511213">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.49124912491249%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0192__p1110745182112">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="55.84558455845584%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0192__p3107552214">Elastic resource pools you want to unbind from the enhanced datasource connection.</p>
</td>
</tr>
</tbody>
</table>
</div>

View File

@ -389,7 +389,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job related APIs</a></div>
</div>
</div>

View File

@ -222,7 +222,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job related APIs</a></div>
</div>
</div>

View File

@ -0,0 +1,19 @@
<a name="dli_02_0356"></a><a name="dli_02_0356"></a>
<h1 class="topictitle1">Resource-related APIs</h1>
<div id="body0000001525581365"><p id="dli_02_0356__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dli_02_0166.html">Package Group-related APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0027.html">Database-related APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dli_02_0031.html">Table-related APIs</a></strong><br>
</li>
</ul>
</div>

View File

@ -1,6 +1,6 @@
<a name="dli_02_0500"></a><a name="dli_02_0500"></a>
<h1 class="topictitle1">Calling APIs</h1>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body0000001339724658"><p id="dli_02_0500__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="dli_02_0500__i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="dli_02_0500__b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="dli_02_0500__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="dli_02_0500__b3082532510259">Application/json</strong>.</p>
<p id="dli_02_0500__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>