forked from docs/doc-exports
fanqinying
ccc163eb84
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: fanqinying <fanqinying@huawei.com> Co-committed-by: fanqinying <fanqinying@huawei.com>
60 lines
7.1 KiB
HTML
60 lines
7.1 KiB
HTML
<a name="er_02_0001"></a><a name="er_02_0001"></a>
|
|
|
|
<h1 class="topictitle1">API Usage Guidelines</h1>
|
|
<div id="body8662426"><p id="er_02_0001__en-us_topic_0020507759_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="er_02_0001__en-us_topic_0020507759_i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="er_02_0001__en-us_topic_0020507759_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
|
|
<p id="er_02_0001__en-us_topic_0020507759_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="er_02_0001__en-us_topic_0020507759_b3082532510259">application/json</strong>.</p>
|
|
<p id="er_02_0001__en-us_topic_0020507759_p899246910259">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="p" id="er_02_0001__p8495658295">Network instances can be attached to an enterprise router as its attachments. The attachment type varies depending on the network instance.<div class="fignone" id="er_02_0001__fig634314337102"><span class="figcap"><b>Figure 1 </b>Attachments</span><br><span><img class="eddx" id="er_02_0001__en-us_topic_0000001135145248_image1216917331811" src="en-us_image_0000001427131632.png"></span></div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="er_02_0001__table183439330102" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Enterprise Router attachments</caption><thead align="left"><tr id="er_02_0001__row1734316339106"><th align="left" class="cellrowborder" valign="top" width="18.72%" id="mcps1.3.4.2.2.6.1.1"><p id="er_02_0001__p1343193314108">Attachment Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.4.2.2.6.1.2"><p id="er_02_0001__p20343183317104">Network Instance</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.84%" id="mcps1.3.4.2.2.6.1.3"><p id="er_02_0001__p7343113301017">Creating an Attachment</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.26%" id="mcps1.3.4.2.2.6.1.4"><p id="er_02_0001__p8343113314101">Querying Attachment Details</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.2.6.1.5"><p id="er_02_0001__p03431633161013">Deleting an Attachment</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="er_02_0001__row334373321017"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.2.6.1.1 "><p id="er_02_0001__p10343103361018">VPC attachment</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.6.1.2 "><p id="er_02_0001__p1434313312103">VPC</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.84%" headers="mcps1.3.4.2.2.6.1.3 "><p id="er_02_0001__p34530685311"><a href="https://docs.otc.t-systems.com/enterprise-router/api-ref/apis/vpc_attachments/creating_a_vpc_attachment.html#creating-a-vpc-attachment" target="_blank" rel="noopener noreferrer">Creating a VPC Attachment</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.26%" headers="mcps1.3.4.2.2.6.1.4 "><p id="er_02_0001__p17957122685312"><a href="https://docs.otc.t-systems.com/enterprise-router/api-ref/apis/vpc_attachments/querying_details_about_a_vpc_attachment.html#showvpcattachment" target="_blank" rel="noopener noreferrer">Querying Details About a VPC Attachment</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.6.1.5 "><p id="er_02_0001__p1113816403534"><a href="https://docs.otc.t-systems.com/enterprise-router/api-ref/apis/vpc_attachments/deleting_a_vpc_attachment.html#deletevpcattachment" target="_blank" rel="noopener noreferrer">Deleting a VPC Attachment</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="er_02_0001__row456105612319"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.2.6.1.1 "><p id="er_02_0001__p149351240240">Virtual gateway attachment</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.6.1.2 "><p id="er_02_0001__p69351248242">Virtual gateway of Direct Connect</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.84%" headers="mcps1.3.4.2.2.6.1.3 "><p id="er_02_0001__p3792529171610">Create a virtual gateway by referring to <a href="https://docs.otc.t-systems.com/direct-connect/api-ref/apis/virtual_gateway/creating_a_virtual_gateway.html" target="_blank" rel="noopener noreferrer">Creating a Virtual Gateway</a> and then attach it to an enterprise router.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.26%" headers="mcps1.3.4.2.2.6.1.4 "><p id="er_02_0001__p1881201755413"><a href="https://docs.otc.t-systems.com/enterprise-router/api-ref/apis/attachments/querying_details_about_an_attachment.html#showattachment" target="_blank" rel="noopener noreferrer">Querying Details About an Attachment</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.6.1.5 "><p id="er_02_0001__p165511056182"><a href="https://docs.otc.t-systems.com/direct-connect/api-ref/apis/virtual_gateway/deleting_a_virtual_gateway.html#" target="_blank" rel="noopener noreferrer">Deleting a Virtual Gateway</a></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="er_02_0001__row9468203210512"><td class="cellrowborder" valign="top" width="18.72%" headers="mcps1.3.4.2.2.6.1.1 "><p id="er_02_0001__p9251415181711">VPN gateway attachment</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.2.6.1.2 "><p id="er_02_0001__p12642732171619">VPN gateway</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.84%" headers="mcps1.3.4.2.2.6.1.3 "><p id="er_02_0001__p3469173219512">Create a VPN gateway by referring to <a href="https://docs.otc.t-systems.com/virtual-private-network/api-ref/api_reference_enterprise_edition_vpn/apis_of_enterprise_edition_vpn/vpn_gateway/creating_a_vpn_gateway.html" target="_blank" rel="noopener noreferrer">Creating a VPN Gateway</a> and then attach it to an enterprise router.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.26%" headers="mcps1.3.4.2.2.6.1.4 "><p id="er_02_0001__p2010762012544"><a href="https://docs.otc.t-systems.com/enterprise-router/api-ref/apis/attachments/querying_details_about_an_attachment.html#showattachment" target="_blank" rel="noopener noreferrer">Querying Details About an Attachment</a></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.6.1.5 "><p id="er_02_0001__p104691532175114"><a href="https://docs.otc.t-systems.com/virtual-private-network/api-ref/api_reference_enterprise_edition_vpn/apis_of_enterprise_edition_vpn/vpn_gateway/deleting_a_vpn_gateway.html" target="_blank" rel="noopener noreferrer">Deleting a VPN Gateway</a></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|