forked from docs/doc-exports
Artem Goncharov
3196b64bfc
move doc sources to other location Reviewed-by: OpenTelekomCloud Bot <None>
48 lines
4.3 KiB
HTML
48 lines
4.3 KiB
HTML
<a name="EN-US_TOPIC_0134193004"></a><a name="EN-US_TOPIC_0134193004"></a>
|
|
|
|
<h1 class="topictitle1">Request Format</h1>
|
|
<div id="body2620092"><p class="MsoNormal" id="EN-US_TOPIC_0134193004__p10047709">Public cloud APIs follow RESTful API design rules.</p>
|
|
<p class="MsoNormal" id="EN-US_TOPIC_0134193004__p23320522">Representational State Transfer (REST) allocates Uniform Resource Identifiers (URIs) to dispersed resources so that resources can be located. Applications on clients use Uniform Resource Locators (URLs) to obtain resources.</p>
|
|
<p class="MsoNormal" id="EN-US_TOPIC_0134193004__p8558107">URLs are in the format of https://Endpoint/uri. <a href="#EN-US_TOPIC_0134193004__table64845234">Table 1</a> describes the parameters in a URL.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0134193004__table64845234"></a><a name="table64845234"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0134193004__table64845234" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0134193004__row49769413"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.3.1.1"><p id="EN-US_TOPIC_0134193004__p4790635">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="79%" id="mcps1.3.4.2.3.1.2"><p id="EN-US_TOPIC_0134193004__p2712671">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0134193004__row31380730"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.3.1.1 "><p id="EN-US_TOPIC_0134193004__p58811235">Endpoint</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.4.2.3.1.2 "><p id="EN-US_TOPIC_0134193004__p9345145171210">Specifies the URL that is the entry point for a web service. Obtain the endpoint from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0134193004__row51657402"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.3.1.1 "><p id="EN-US_TOPIC_0134193004__p23500024">URI</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="79%" headers="mcps1.3.4.2.3.1.2 "><p id="EN-US_TOPIC_0134193004__p24453795">Specifies a resource path, which is an API access path and obtained from the API URI module, for example, /v2/{tenant_id}/servers.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p class="MsoNormal" id="EN-US_TOPIC_0134193004__p46736194">A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID on the console before calling an API. To do so, perform the following operations:</p>
|
|
<ol id="EN-US_TOPIC_0134193004__ol149414459116"><li class="MsoNormal" id="EN-US_TOPIC_0134193004__li179415458116">Register yourself on the management console and log in to it.</li><li class="MsoNormal" id="EN-US_TOPIC_0134193004__li39415455113">Hover the mouse over the username and select <strong id="EN-US_TOPIC_0134193004__b151905481831">Basic Information</strong> from the drop-down list.</li><li class="MsoNormal" id="EN-US_TOPIC_0134193004__li12941545512">On the <strong id="EN-US_TOPIC_0134193004__b84235270611835">Account Info</strong> page, click <strong id="EN-US_TOPIC_0134193004__b84235270611958">Manage</strong> following <strong id="EN-US_TOPIC_0134193004__b84235270611102">Security Credentials</strong>.</li><li class="MsoNormal" id="EN-US_TOPIC_0134193004__li179414452110">On the <strong id="EN-US_TOPIC_0134193004__b842352706111039">My Credential</strong> page, view the project ID in the project list.<div class="fignone" id="EN-US_TOPIC_0134193004__fig82901053211"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="EN-US_TOPIC_0134193004__image18757564" src="en-us_image_0173496413.png" title="Click to enlarge" class="imgResize"></span></div>
|
|
</li></ol>
|
|
</div>
|
|
<div>
|
|
<ul class="ullinks">
|
|
<li class="ulchildlink"><strong><a href="en-us_topic_0134193005.html">Versions</a></strong><br>
|
|
</li>
|
|
<li class="ulchildlink"><strong><a href="en-us_topic_0134193006.html">Microversions</a></strong><br>
|
|
</li>
|
|
<li class="ulchildlink"><strong><a href="en-us_topic_0134192984.html">Request Example</a></strong><br>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<script language="JavaScript">
|
|
<!--
|
|
image_size('.imgResize');
|
|
var msg_imageMax = "view original image";
|
|
var msg_imageClose = "close";
|
|
//--></script> |