1
0
forked from docs/doc-exports

DC API 20231101 version

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
This commit is contained in:
Qin Ying, Fan 2024-03-11 15:10:40 +00:00 committed by zuul
parent b2ab78f7cf
commit 62ab8a5fe2
85 changed files with 14123 additions and 2687 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,99 @@
<a name="DeleteDirectConnect"></a><a name="DeleteDirectConnect"></a>
<h1 class="topictitle1">Deleting a Connection</h1>
<div id="body8662426"><div class="section" id="DeleteDirectConnect__en-us_topic_0000001782745837_section2905238163418"><h4 class="sectiontitle">Function</h4><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1590573893415">This API is used to delete pay-per-use connections only. To delete yearly/monthly connections, you need to first unsubscribe them.</p>
</div>
<div class="section" id="DeleteDirectConnect__en-us_topic_0000001782745837_section290643816341"><h4 class="sectiontitle">URI</h4><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p8906173812349">DELETE /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDirectConnect__en-us_topic_0000001782745837_table12907163813346" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteDirectConnect__en-us_topic_0000001782745837_row29069383347"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p11907133812346">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p13908103843412">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p9908638183411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1190813818346">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDirectConnect__en-us_topic_0000001782745837_row990713817345"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p18908338113418">direct_connect_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1909183873410">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p990915385344">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p59091938113410">Specifies the connection ID.</p>
<p id="DeleteDirectConnect__en-us_topic_0000001782745837_p159091338143418">Minimum: <strong id="DeleteDirectConnect__en-us_topic_0000001782745837_b79091638103411">36</strong></p>
<p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1909123814349">Maximum: <strong id="DeleteDirectConnect__en-us_topic_0000001782745837_b8909113823417">36</strong></p>
</td>
</tr>
<tr id="DeleteDirectConnect__en-us_topic_0000001782745837_row290703815341"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1190953853411">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p17910183893417">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1491014386344">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p5910438153417">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteDirectConnect__en-us_topic_0000001782745837_section7911193863412"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDirectConnect__en-us_topic_0000001782745837_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteDirectConnect__en-us_topic_0000001782745837_row1491123843411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1391253883416">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p19121238123419">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p179131738183420">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p129131338103413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDirectConnect__en-us_topic_0000001782745837_row791293819345"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1591373812347">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p9914143893410">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p19145382348">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1591423816341">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="DeleteDirectConnect__en-us_topic_0000001782745837_i9914173813345">Identity and Access Management API Reference</em>. The token is the value of <strong id="DeleteDirectConnect__en-us_topic_0000001782745837_b18914838113412">X-Subject-Token</strong> in the response header.</p>
<p id="DeleteDirectConnect__en-us_topic_0000001782745837_p7914143820340">Minimum: <strong id="DeleteDirectConnect__en-us_topic_0000001782745837_b1691493814347">0</strong></p>
<p id="DeleteDirectConnect__en-us_topic_0000001782745837_p16914123816341">Maximum: <strong id="DeleteDirectConnect__en-us_topic_0000001782745837_b10915123873419">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteDirectConnect__en-us_topic_0000001782745837_section17915838143414"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1291593843411">None</p>
</div>
<div class="section" id="DeleteDirectConnect__en-us_topic_0000001782745837_section4915163883413"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1091603833412">Deleting a connection</p>
<pre class="screen" id="DeleteDirectConnect__en-us_topic_0000001782745837_screen1691663873413">DELETE https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects/6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a</pre>
</div>
<div class="section" id="DeleteDirectConnect__en-us_topic_0000001782745837_section49168382349"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p0916203823415">None</p>
</div>
<div class="section" id="DeleteDirectConnect__en-us_topic_0000001782745837_section7935103818341"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteDirectConnect__en-us_topic_0000001782745837_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteDirectConnect__en-us_topic_0000001782745837_row10935113813419"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p1593611384345">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p8936143820344">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteDirectConnect__en-us_topic_0000001782745837_row59351938153418"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p693610382344">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p20937238203410">No Content</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteDirectConnect__en-us_topic_0000001782745837_section18937163883416"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteDirectConnect__en-us_topic_0000001782745837_p15937193843414">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Connection</a></div>
</div>
</div>

View File

@ -0,0 +1,99 @@
<a name="DeleteHostedDirectConnect"></a><a name="DeleteHostedDirectConnect"></a>
<h1 class="topictitle1">Deleting a Hosted Connection</h1>
<div id="body8662426"><div class="section" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_section2054114016340"><h4 class="sectiontitle">Function</h4><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p354640173410">This API is used by partners to delete hosted connections.</p>
</div>
<div class="section" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_section195514073413"><h4 class="sectiontitle">URI</h4><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p1455134011349">DELETE /v3/{project_id}/dcaas/hosted-connects/{hosted_connect_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_table1857240193411" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_row18561040193418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p65774018341">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p6578404343">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p155718406342">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p1157134063411">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_row656540103412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p55804013419">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p1758174019348">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p55814016342">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p2581040103417">Specifies the project ID.</p>
</td>
</tr>
<tr id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_row1856124063418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p159124013417">hosted_connect_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p95911402345">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p1359204003417">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p17591940163418">Specifies the hosted connection ID.</p>
<p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p9595407345">Minimum: <strong id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_b15591940113411">36</strong></p>
<p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p17592404343">Maximum: <strong id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_b86044083418">36</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_section11601740193413"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_row26014073411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p061134017349">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p961134015344">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p8611240123411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p16627406344">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_row5601340123418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p11621440113418">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p5622040123419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p186324011349">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p163140183420">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_i196324053412">Identity and Access Management API Reference</em>. The token is the value of <strong id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_b1463340183410">X-Subject-Token</strong> in the response header.</p>
<p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p13634409349">Minimum: <strong id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_b106314401343">0</strong></p>
<p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p963124015344">Maximum: <strong id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_b166324010343">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_section1263184018345"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p0631940163412">None</p>
</div>
<div class="section" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_section186494017345"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p56416403341">Deleting a hosted connection</p>
<pre class="screen" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_screen064174053412">DELETE https://{dc_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/dcaas/hosted-connects/94c2b814-99dc-939a-e811-ae84c61ea3ff</pre>
</div>
<div class="section" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_section206454043418"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p19641540163415">None</p>
</div>
<div class="section" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_section780204017342"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_row188164015347"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p108113408341">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p1782184011343">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_row8811340173420"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p168294020345">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p1583204053414">No Content</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_section983164011346"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteHostedDirectConnect__en-us_topic_0000001782705605_p15831840193419">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Connection</a></div>
</div>
</div>

View File

@ -0,0 +1,97 @@
<a name="DeleteVirtualGateway"></a><a name="DeleteVirtualGateway"></a>
<h1 class="topictitle1">Deleting a Virtual Gateway</h1>
<div id="body8662426"><div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section3212213111713"><h4 class="sectiontitle">Function</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p221215131175">The API is used to delete a specified virtual gateway.</p>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section4213171351717"><h4 class="sectiontitle">URI</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p821318130178">DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteVirtualGateway__en-us_topic_0000001782705609_table162141138177" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row4214181312172"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p1021511371713">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p921551371713">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p92151313191716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p22161713151715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row1721461341717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p1721681310171">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p4216413151716">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p17216113201714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p14217101321715">Specifies the project ID.</p>
</td>
</tr>
<tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row72141413101714"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p52170139171">virtual_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p22172013151712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p92171713141711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p1021811316174">Specifies the virtual gateway ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section112181413111717"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteVirtualGateway__en-us_topic_0000001782705609_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row4218813121716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p192195133177">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p9220171311175">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p722012134171">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p1722018139170">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row9219121313172"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p222012135177">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p7221513131716">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p322141321720">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p42211113191713">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="DeleteVirtualGateway__en-us_topic_0000001782705609_i192218137173">Identity and Access Management API Reference</em>. The token is the value of <strong id="DeleteVirtualGateway__en-us_topic_0000001782705609_b102211213131710">X-Subject-Token</strong> in the response header.</p>
<p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p112211513181716">Minimum: <strong id="DeleteVirtualGateway__en-us_topic_0000001782705609_b18221513121717">0</strong></p>
<p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p422213137173">Maximum: <strong id="DeleteVirtualGateway__en-us_topic_0000001782705609_b4222101341713">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section82220133172"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p12222813161711">None</p>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section422211132179"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p3222121381720">Deleting a virtual gateway</p>
<pre class="screen" id="DeleteVirtualGateway__en-us_topic_0000001782705609_screen152235137174">DELETE https://{dc_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/dcaas/virtual-gateways/20082c1b-3c99-48d8-8e8c-116af5d7e9f0</pre>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section102231013101710"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p16223813201712">None</p>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section132401513121711"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteVirtualGateway__en-us_topic_0000001782705609_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row1724119131172"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p0241413201720">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p15242141316178">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteVirtualGateway__en-us_topic_0000001782705609_row152415134170"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p3242813101714">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p11242141371718">No Content</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteVirtualGateway__en-us_topic_0000001782705609_section1524211310171"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteVirtualGateway__en-us_topic_0000001782705609_p124371341716">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000001.html">Virtual Gateway</a></div>
</div>
</div>

View File

@ -0,0 +1,99 @@
<a name="DeleteVirtualInterface"></a><a name="DeleteVirtualInterface"></a>
<h1 class="topictitle1">Deleting a Virtual Interface</h1>
<div id="body8662426"><div class="section" id="DeleteVirtualInterface__en-us_topic_0000001782745853_section9760328151715"><h4 class="sectiontitle">Function</h4><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p14760152810172">This API is used to delete a virtual interface.</p>
</div>
<div class="section" id="DeleteVirtualInterface__en-us_topic_0000001782745853_section11760122812173"><h4 class="sectiontitle">URI</h4><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p0761428121714">DELETE /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteVirtualInterface__en-us_topic_0000001782745853_table1476242851715" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteVirtualInterface__en-us_topic_0000001782745853_row16761152817174"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p187625284170">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p2076222881711">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p7763028161717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p18763928181713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteVirtualInterface__en-us_topic_0000001782745853_row1076119284178"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p5763628121712">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p876472871718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p187641428191715">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p14764182851710">Specifies the project ID.</p>
</td>
</tr>
<tr id="DeleteVirtualInterface__en-us_topic_0000001782745853_row19761028181717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p1376452817170">virtual_interface_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p376519284179">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p27651728181711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p1076562871717">Specifies the virtual interface ID.</p>
<p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p3765182861710">Minimum: <strong id="DeleteVirtualInterface__en-us_topic_0000001782745853_b187656283174">36</strong></p>
<p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p107653283174">Maximum: <strong id="DeleteVirtualInterface__en-us_topic_0000001782745853_b17651528201716">36</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteVirtualInterface__en-us_topic_0000001782745853_section076617281177"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteVirtualInterface__en-us_topic_0000001782745853_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="DeleteVirtualInterface__en-us_topic_0000001782745853_row157662028101711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p13767112871712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p1676719285179">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p176712841717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p776852881719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteVirtualInterface__en-us_topic_0000001782745853_row10766142818178"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p576852811714">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p676822816176">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p157681428141714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p77685280178">Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the <em id="DeleteVirtualInterface__en-us_topic_0000001782745853_i1076972814171">Identity and Access Management API Reference</em>. The token is the value of <strong id="DeleteVirtualInterface__en-us_topic_0000001782745853_b6769162861713">X-Subject-Token</strong> in the response header.</p>
<p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p177691928151712">Minimum: <strong id="DeleteVirtualInterface__en-us_topic_0000001782745853_b7769628121714">0</strong></p>
<p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p776918286178">Maximum: <strong id="DeleteVirtualInterface__en-us_topic_0000001782745853_b67691928171711">10240</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteVirtualInterface__en-us_topic_0000001782745853_section17691528181718"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p776982851711">None</p>
</div>
<div class="section" id="DeleteVirtualInterface__en-us_topic_0000001782745853_section10769628121713"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p1277062812177">Deleting a virtual interface</p>
<pre class="screen" id="DeleteVirtualInterface__en-us_topic_0000001782745853_screen77705284172">DELETE https://{dc_endpoint}/v3/0605768a3300d5762f82c01180692873/dcaas/virtual-interfaces/0d0fdf63-f2c4-491c-8866-d504796189be</pre>
</div>
<div class="section" id="DeleteVirtualInterface__en-us_topic_0000001782745853_section4770102811716"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p18770528111713">None</p>
</div>
<div class="section" id="DeleteVirtualInterface__en-us_topic_0000001782745853_section57861228191716"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteVirtualInterface__en-us_topic_0000001782745853_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteVirtualInterface__en-us_topic_0000001782745853_row1778613284178"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p17878281178">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p1678712814176">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="DeleteVirtualInterface__en-us_topic_0000001782745853_row1778702811711"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p578762817179">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p178818286178">No Content</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="DeleteVirtualInterface__en-us_topic_0000001782745853_section6788172820174"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteVirtualInterface__en-us_topic_0000001782745853_p10788028171710">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002.html">Virtual Interface</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,16 @@
<a name="dc_07_0000"></a><a name="dc_07_0000"></a>
<h1 class="topictitle1">APIs v3</h1>
<div id="body0000001678327972"><p id="dc_07_0000__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="topic_300000000.html">Connection</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000001.html">Virtual Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000002.html">Virtual Interface</a></strong><br>
</li>
</ul>
</div>

View File

@ -1,6 +1,6 @@
<a name="dc_08_0000"></a><a name="dc_08_0000"></a>
<h1 class="topictitle1">Permissions Policies and Supported Actions</h1>
<h1 class="topictitle1">Permissions Policies and Supported Actions (APIs v2.0)</h1>
<div id="body0000001563574725"></div>
<div>
<ul class="ullinks">

View File

@ -1,7 +1,7 @@
<a name="dc_08_0001"></a><a name="dc_08_0001"></a>
<h1 class="topictitle1">Introduction</h1>
<div id="body0000001512215124"><p id="dc_08_0001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_p686912134917">This chapter describes fine-grained permissions management for your Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, then you may skip over this chapter.</p>
<div id="body0000001512215124"><p id="dc_08_0001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_p686912134917">This chapter describes fine-grained permissions management for Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, you can skip over this chapter.</p>
<p id="dc_08_0001__p184451927144417">By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.</p>
<p id="dc_08_0001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_p1386992104912">You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
<div class="note" id="dc_08_0001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_note2789122144911"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dc_08_0001__en-us_topic_0201534299_p136518546438">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
@ -17,7 +17,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_0000.html">Permissions Policies and Supported Actions</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_0000.html">Permissions Policies and Supported Actions (APIs v2.0)</a></div>
</div>
</div>

View File

@ -88,7 +88,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_0000.html">Permissions Policies and Supported Actions</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_0000.html">Permissions Policies and Supported Actions (APIs v2.0)</a></div>
</div>
</div>

View File

@ -89,7 +89,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_0000.html">Permissions Policies and Supported Actions</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_0000.html">Permissions Policies and Supported Actions (APIs v2.0)</a></div>
</div>
</div>

View File

@ -89,7 +89,7 @@
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_0000.html">Permissions Policies and Supported Actions</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_0000.html">Permissions Policies and Supported Actions (APIs v2.0)</a></div>
</div>
</div>

View File

@ -0,0 +1,17 @@
<a name="dc_08_3000"></a><a name="dc_08_3000"></a>
<h1 class="topictitle1">Permissions Policies and Supported Actions (APIs v3)</h1>
<div id="body0000001693589372"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="dc_08_3001.html">Introduction</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dc_08_3002.html">Connections</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dc_08_3003.html">Virtual Gateways</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dc_08_3004.html">Virtual Interfaces</a></strong><br>
</li>
</ul>
</div>

View File

@ -0,0 +1,23 @@
<a name="dc_08_3001"></a><a name="dc_08_3001"></a>
<h1 class="topictitle1">Introduction</h1>
<div id="body0000001741229629"><p id="dc_08_3001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_p686912134917">This topic describes fine-grained permissions management for Direct Connect. If your cloud account does not need individual Identity and Access Management (IAM) users, you can skip over this chapter.</p>
<p id="dc_08_3001__p184451927144417">By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.</p>
<p id="dc_08_3001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_p1386992104912">You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
<div class="note" id="dc_08_3001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_note2789122144911"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dc_08_3001__en-us_topic_0201534299_p136518546438">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
</div></div>
<p id="dc_08_3001__p189429342514">An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query the connections using an API, the user must have been granted permissions that allow the <strong id="dc_08_3001__b17817165716377">dcaas:directConnect:list</strong> action.</p>
<div class="section" id="dc_08_3001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_section677212217497"><h4 class="sectiontitle">Supported Actions</h4><p id="dc_08_3001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_p187062194916">IAM provides system-defined policies that can be directly used. You can also create custom policies to work with system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>
<ul id="dc_08_3001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_ul1487018213498"><li id="dc_08_3001__en-us_topic_0201534299_li1570634614316">Permissions: Statements in a policy that allow or deny certain operations.</li><li id="dc_08_3001__en-us_topic_0201534299_li89438340514">APIs: REST APIs that can be called by a user who has been granted specific permissions.</li><li id="dc_08_3001__en-us_topic_0201534299_li109432341551">Actions: Specific operations that are allowed or denied.</li><li id="dc_08_3001__en-us_topic_0201534299_li79437341758">IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM. For details about the differences between IAM projects and enterprise projects, see "What Are the Differences Between IAM and Enterprise Management?" in the <em id="dc_08_3001__i159291124111916">Identity and Access Management User Guide</em>.<div class="note" id="dc_08_3001__en-us_topic_0201534299_note11849175416198"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dc_08_3001__en-us_topic_0201534299_p1184965471913">The check mark (√) and cross symbol (x) indicate that an action takes effect or does not take effect for the corresponding type of projects.</p>
</div></div>
</li></ul>
<p id="dc_08_3001__en-us_topic_0178454989_en-us_topic_0173706814_en-us_topic_0171716105_p20870102118497">Direct Connect supports the following actions that can be defined in custom policies:</p>
<ul id="dc_08_3001__ul8428183772113"><li id="dc_08_3001__li1428153719217"><a href="dc_08_3002.html">Connections</a>: contains actions supported by the APIs of Direct Connect connections, for example, creating a connection.</li><li id="dc_08_3001__li8428537162112"><a href="dc_08_3003.html">Virtual Gateways</a>: contains actions supported by the APIs of Direct Connect virtual gateway, such as creating a virtual gateway.</li><li id="dc_08_3001__li242813702115"><a href="dc_08_3004.html">Virtual Interfaces</a>: contains actions supported by the APIs of Direct Connect virtual interfaces, for example, creating a virtual interface.</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_3000.html">Permissions Policies and Supported Actions (APIs v3)</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,95 @@
<a name="dc_08_3003"></a><a name="dc_08_3003"></a>
<h1 class="topictitle1">Virtual Gateways</h1>
<div id="body0000001741349477">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dc_08_3003__table930910161495" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Actions allowed for virtual gateways</caption><thead align="left"><tr id="dc_08_3003__row1015517691"><th align="left" class="cellrowborder" valign="top" width="14.500000000000002%" id="mcps1.3.1.2.7.1.1"><p id="dc_08_3003__p0163172093">Permission</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.750000000000004%" id="mcps1.3.1.2.7.1.2"><p id="dc_08_3003__p18295111810169">API</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.420000000000003%" id="mcps1.3.1.2.7.1.3"><p id="dc_08_3003__p15509182516274">Action</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.330000000000005%" id="mcps1.3.1.2.7.1.4"><p id="dc_08_3003__p14675557351">Related Action</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.15%" id="mcps1.3.1.2.7.1.5"><p id="dc_08_3003__p1838971541713">IAM Project</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.850000000000003%" id="mcps1.3.1.2.7.1.6"><p id="dc_08_3003__p475572121720">Enterprise Project</p>
</th>
</tr>
</thead>
<tbody><tr id="dc_08_3003__row816141720910"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3003__p816817399">Creating a virtual gateway</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3003__p125985501221">POST /v3/{project_id}/dcaas/virtual-gateways</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3003__p7105195743712">dcaas:vgw:create</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3003__p86371924131711">vpc:vpcs:get</p>
<p id="dc_08_3003__p10637112413178">vpc:vpcs:list</p>
<p id="dc_08_3003__p5637132414172">vpc:subnets:get</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3003__p1523614642915"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3003__p1723612615292">×</p>
</td>
</tr>
<tr id="dc_08_3003__row161618171099"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3003__p816217698">Querying the virtual gateway list</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3003__p136971450132817">GET /v3/{project_id}/dcaas/virtual-gateways</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3003__p693016182197">dcaas:vgw:list</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3003__p189291918131913">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3003__p172520563814"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3003__p1125213523818">×</p>
</td>
</tr>
<tr id="dc_08_3003__row77781646134414"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3003__p17169170919">Querying a virtual gateway</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3003__p122611539134514">GET /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3003__p10924181812199">dcaas:vgw:get</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3003__p8924131819194">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3003__p844919419384"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3003__p1044904193810">×</p>
</td>
</tr>
<tr id="dc_08_3003__row2169177920"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3003__p14919411057">Updating a virtual gateway</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3003__p1639563974514">PUT /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3003__p1792231818192">dcaas:vgw:update</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3003__p189211718121914">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3003__p02854163818"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3003__p92818420387">×</p>
</td>
</tr>
<tr id="dc_08_3003__row41610171697"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3003__p5165171595">Deleting a virtual gateway</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3003__p177285344517">DELETE /v3/{project_id}/dcaas/virtual-gateways/{virtual_gateway_id}</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3003__p169284184197">dcaas:vgw:delete</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3003__p8927181818192">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3003__p78591344381"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3003__p9859142389">×</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_3000.html">Permissions Policies and Supported Actions (APIs v3)</a></div>
</div>
</div>

View File

@ -0,0 +1,95 @@
<a name="dc_08_3004"></a><a name="dc_08_3004"></a>
<h1 class="topictitle1">Virtual Interfaces</h1>
<div id="body0000001693589376">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dc_08_3004__table930910161495" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Actions allowed for virtual interfaces</caption><thead align="left"><tr id="dc_08_3004__row1015517691"><th align="left" class="cellrowborder" valign="top" width="14.500000000000002%" id="mcps1.3.1.2.7.1.1"><p id="dc_08_3004__p0163172093">Permission</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.750000000000004%" id="mcps1.3.1.2.7.1.2"><p id="dc_08_3004__p18295111810169">API</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.420000000000003%" id="mcps1.3.1.2.7.1.3"><p id="dc_08_3004__p15509182516274">Action</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.330000000000005%" id="mcps1.3.1.2.7.1.4"><p id="dc_08_3004__p14675557351">Related Action</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.15%" id="mcps1.3.1.2.7.1.5"><p id="dc_08_3004__p1838971541713">IAM Project</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.850000000000003%" id="mcps1.3.1.2.7.1.6"><p id="dc_08_3004__p475572121720">Enterprise Project</p>
</th>
</tr>
</thead>
<tbody><tr id="dc_08_3004__row816141720910"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3004__p816817399">Creating a virtual interface</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3004__p62826911463">POST /v3/{project_id}/dcaas/virtual-interfaces</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3004__p19191123220353">dcaas:vif:create</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3004__p86371924131711">vpc:vpcs:get</p>
<p id="dc_08_3004__p10637112413178">vpc:vpcs:list</p>
<p id="dc_08_3004__p5637132414172">vpc:subnets:get</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3004__p1523614642915"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3004__p1723612615292">×</p>
</td>
</tr>
<tr id="dc_08_3004__row161618171099"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3004__p816217698">Querying the virtual interface list</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3004__p13944201614619">GET /v3/{project_id}/dcaas/virtual-interfaces</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3004__p1561673193115">dcaas:vif:list</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3004__p161683115313">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3004__p17308141183817"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3004__p1330831133817">×</p>
</td>
</tr>
<tr id="dc_08_3004__row4101874515"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3004__p17169170919">Querying a virtual interface</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3004__p710452615465">GET /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3004__p461063113113">dcaas:vif:get</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3004__p29511919163810">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3004__p31681828386"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3004__p141687203816">×</p>
</td>
</tr>
<tr id="dc_08_3004__row2169177920"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3004__p14919411057">Updating a virtual interface</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3004__p1727411269464">PUT /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3004__p960793193112">dcaas:vif:update</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3004__p10950151914389">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3004__p96098243811"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3004__p116101825382">×</p>
</td>
</tr>
<tr id="dc_08_3004__row41610171697"><td class="cellrowborder" valign="top" width="14.500000000000002%" headers="mcps1.3.1.2.7.1.1 "><p id="dc_08_3004__p5165171595">Deleting a virtual interface</p>
</td>
<td class="cellrowborder" valign="top" width="21.750000000000004%" headers="mcps1.3.1.2.7.1.2 "><p id="dc_08_3004__p3953143315463">DELETE /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}</p>
</td>
<td class="cellrowborder" valign="top" width="15.420000000000003%" headers="mcps1.3.1.2.7.1.3 "><p id="dc_08_3004__p136131631163112">dcaas:vif:delete</p>
</td>
<td class="cellrowborder" valign="top" width="20.330000000000005%" headers="mcps1.3.1.2.7.1.4 "><p id="dc_08_3004__p199510192382">-</p>
</td>
<td class="cellrowborder" valign="top" width="12.15%" headers="mcps1.3.1.2.7.1.5 "><p id="dc_08_3004__p37161119388"></p>
</td>
<td class="cellrowborder" valign="top" width="15.850000000000003%" headers="mcps1.3.1.2.7.1.6 "><p id="dc_08_3004__p207165116386">×</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dc_08_3000.html">Permissions Policies and Supported Actions (APIs v3)</a></div>
</div>
</div>

View File

@ -1,41 +0,0 @@
<a name="en-dc_topic_0055025301"></a><a name="en-dc_topic_0055025301"></a>
<h1 class="topictitle1">API Overview</h1>
<div id="body1537951352085"><p id="en-dc_topic_0055025301__p980163214216">Direct Connect APIs allow you to use all Direct Connect functions.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025301__table5876102613294"></a><a name="table5876102613294"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025301__table5876102613294" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Direct Connect APIs</caption><thead align="left"><tr id="en-dc_topic_0055025301__row3878122616298"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.4.1.1"><p id="en-dc_topic_0055025301__p487811268290">Category</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.2.4.1.2"><p id="en-dc_topic_0055025301__p68781126182914">Subcategory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64%" id="mcps1.3.2.2.4.1.3"><p id="en-dc_topic_0055025301__p158781726112914">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025301__row148781026122919"><td class="cellrowborder" rowspan="4" valign="top" width="17%" headers="mcps1.3.2.2.4.1.1 "><p id="en-dc_topic_0055025301__p16878726162916">Direct Connect API</p>
</td>
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.4.1.2 "><p id="en-dc_topic_0055025301__p128788265295">Connection</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.2.2.4.1.3 "><p id="en-dc_topic_0055025301__p155621015155120">Used to manage connections, including the API used to create a hosted connection, the APIs used to query, delete, and update a connection, and the API to query the connection list.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025301__row1987820263297"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="en-dc_topic_0055025301__p8939172693215">Virtual gateway</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.2 "><p id="en-dc_topic_0055025301__p49241952">Used to manage virtual gateways, including the APIs used to create, delete, query, and update a virtual gateway, and the API to query the virtual gateway list.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025301__row87746166614"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="en-dc_topic_0055025301__p73349397495">Virtual interface</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.2 "><p id="en-dc_topic_0055025301__p19860558104553">Used to manage virtual interfaces, including the APIs used to create, delete, query, and update a virtual interface, and the API to query the virtual interface list.</p>
</td>
</tr>
<tr id="en-dc_topic_0055025301__row816313459617"><td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.1 "><p id="en-dc_topic_0055025301__p1216317451267">Direct Connect endpoint group</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.3.2.2.4.1.2 "><p id="en-dc_topic_0055025301__p7163194516616">Used to manage Direct Connect endpoint groups, including the APIs used to create, delete, query, and update a Direct Connect endpoint group, and the API to query the Direct Connect endpoint group list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div></div>

View File

@ -1,19 +0,0 @@
<a name="en-dc_topic_0055025309"></a><a name="en-dc_topic_0055025309"></a>
<h1 class="topictitle1">APIs</h1>
<div id="body1539589976314"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025310.html">Obtaining the API Version Information</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025313.html">Connection</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025320.html">Virtual Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025327.html">Virtual Interface</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025334.html">Direct Connect Endpoint Group</a></strong><br>
</li>
</ul>
</div>

View File

@ -1,46 +0,0 @@
<a name="en-dc_topic_0055025317"></a><a name="en-dc_topic_0055025317"></a>
<h1 class="topictitle1">Deleting a Connection </h1>
<div id="body13265486"><div class="section" id="en-dc_topic_0055025317__section43031324205035"><a name="en-dc_topic_0055025317__section43031324205035"></a><a name="section43031324205035"></a><h4 class="sectiontitle">Function</h4><p id="en-dc_topic_0055025317__p62985257205035">This API is used to delete a connection.</p>
</div>
<div class="section" id="en-dc_topic_0055025317__section29996404205035"><a name="en-dc_topic_0055025317__section29996404205035"></a><a name="section29996404205035"></a><h4 class="sectiontitle">URI</h4><p id="en-dc_topic_0055025317__p5517124514424">DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025317__table332210240312" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-dc_topic_0055025317__row163310241312"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.3.2.5.1.1"><p id="en-dc_topic_0055025317__p16331182453110">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.42785721427857%" id="mcps1.3.2.3.2.5.1.2"><p id="en-dc_topic_0055025317__p433132411319"><strong id="en-dc_topic_0055025317__b842352706165439">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.328367163283673%" id="mcps1.3.2.3.2.5.1.3"><p id="en-dc_topic_0055025317__p1331132453112"><strong id="en-dc_topic_0055025317__b842352706192549">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.85571442855714%" id="mcps1.3.2.3.2.5.1.4"><p id="en-dc_topic_0055025317__p933116245312"><strong id="en-dc_topic_0055025317__b84235270615331">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025317__row17331122423114"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-dc_topic_0055025317__p233116246318">direct_connect_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.42785721427857%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-dc_topic_0055025317__p83314249313">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.328367163283673%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-dc_topic_0055025317__p11331112493112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42.85571442855714%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-dc_topic_0055025317__p8331172463114">Specifies the connection ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025317__section54655929205035"><h4 class="sectiontitle">Request</h4><p id="en-dc_topic_0055025317__p19224102883919">None</p>
</div>
<div class="section" id="en-dc_topic_0055025317__section48616095205035"><h4 class="sectiontitle">Response</h4><p id="en-dc_topic_0055025317__p45589619205035">None</p>
</div>
<div class="section" id="en-dc_topic_0055025317__section7653394205035"><h4 class="sectiontitle">Examples</h4><ul id="en-dc_topic_0055025317__ul448314187356"><li id="en-dc_topic_0055025317__li1748361893518">Example request</li></ul>
<pre class="screen" id="en-dc_topic_0055025317__screen15945198205035">DELETE /v2.0/dcaas/direct-connects/{direct_connect_id}</pre>
</div>
<div class="section" id="en-dc_topic_0055025317__section19131184615323"><h4 class="sectiontitle">Status Codes</h4><p id="en-dc_topic_0055025317__p176816317298">For details, see <a href="en-dc_topic_0055025342.html">Common Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025313.html">Connection</a></div>
</div>
</div>

View File

@ -1,29 +0,0 @@
<a name="en-dc_topic_0055025320"></a><a name="en-dc_topic_0055025320"></a>
<h1 class="topictitle1">Virtual Gateway</h1>
<div id="body1489114536418"><p id="en-dc_topic_0055025320__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025321.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025322.html">Creating a Virtual Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025323.html">Querying the Virtual Gateway List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025324.html">Deleting a Virtual Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025325.html">Querying a Virtual Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025326.html">Updating a Virtual Gateway</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025309.html">APIs</a></div>
</div>
</div>

View File

@ -1,71 +0,0 @@
<a name="en-dc_topic_0055025324"></a><a name="en-dc_topic_0055025324"></a>
<h1 class="topictitle1">Deleting a Virtual Gateway</h1>
<div id="body1489114536418"><div class="section" id="en-dc_topic_0055025324__section43031324205035"><h4 class="sectiontitle">Function</h4><p id="en-dc_topic_0055025324__p62985257205035">This API is used to delete a virtual gateway.</p>
</div>
<div class="section" id="en-dc_topic_0055025324__section29996404205035"><a name="en-dc_topic_0055025324__section29996404205035"></a><a name="section29996404205035"></a><h4 class="sectiontitle">URI</h4><p id="en-dc_topic_0055025324__p2568244204">DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025324__table2653155192017" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-dc_topic_0055025324__row165355510201"><th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.2.3.2.5.1.1"><p id="en-dc_topic_0055025324__p1865314551207">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.151515151515152%" id="mcps1.3.2.3.2.5.1.2"><p id="en-dc_topic_0055025324__p965345514201"><strong id="en-dc_topic_0055025324__b842352706165439">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.2.3.2.5.1.3"><p id="en-dc_topic_0055025324__p136531556208"><strong id="en-dc_topic_0055025324__b842352706192549">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.46464646464647%" id="mcps1.3.2.3.2.5.1.4"><p id="en-dc_topic_0055025324__p14660155542013"><strong id="en-dc_topic_0055025324__b84235270615331">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025324__row13660145572012"><td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-dc_topic_0055025324__p866020558209">virtual_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-dc_topic_0055025324__p9660145552017">String</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-dc_topic_0055025324__p12660195532019">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46.46464646464647%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-dc_topic_0055025324__p866065522015">Specifies the virtual gateway ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025324__section54655929205035"><a name="en-dc_topic_0055025324__section54655929205035"></a><a name="section54655929205035"></a><h4 class="sectiontitle">Request</h4><p id="en-dc_topic_0055025324__p9691133616216"><a href="#en-dc_topic_0055025324__table2198437322244">Table 2</a> lists the request parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025324__table2198437322244"></a><a name="table2198437322244"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025324__table2198437322244" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-dc_topic_0055025324__row4304807922244"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.3.3.2.5.1.1"><p id="en-dc_topic_0055025324__p6505580022244"><strong id="en-dc_topic_0055025324__b8423527069918">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.3.2.5.1.2"><p id="en-dc_topic_0055025324__p329696222244"><strong id="en-dc_topic_0055025324__b206530648">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="en-dc_topic_0055025324__p3257067222244"><strong id="en-dc_topic_0055025324__b1244418076">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.3.2.5.1.4"><p id="en-dc_topic_0055025324__p5470821922244"><strong id="en-dc_topic_0055025324__b296773316">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025324__row5451891922244"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-dc_topic_0055025324__p3187982384832">virtual_gateway_id</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-dc_topic_0055025324__p757920222316">String</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-dc_topic_0055025324__p4706384922316">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-dc_topic_0055025324__p970883222316">Specifies the virtual gateway ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025324__section48616095205035"><h4 class="sectiontitle">Response</h4><p id="en-dc_topic_0055025324__p45589619205035">None</p>
</div>
<div class="section" id="en-dc_topic_0055025324__section7653394205035"><h4 class="sectiontitle">Examples</h4><ul id="en-dc_topic_0055025324__ul1559143362211"><li id="en-dc_topic_0055025324__li155983310227">Example request</li></ul>
<pre class="screen" id="en-dc_topic_0055025324__screen15945198205035">DELETE /v2.0/dcaas/virtual-gateways/{virtual_gateway_id}</pre>
</div>
<ul id="en-dc_topic_0055025324__ul12353133851018"><li id="en-dc_topic_0055025324__li23531386103">Response example<p id="en-dc_topic_0055025324__p1393018459105"><a name="en-dc_topic_0055025324__li23531386103"></a><a name="li23531386103"></a>None</p>
</li></ul>
<div class="section" id="en-dc_topic_0055025324__section5604023173234"><h4 class="sectiontitle">Status Codes</h4><p id="en-dc_topic_0055025324__p176816317298">For details, see <a href="en-dc_topic_0055025342.html">Common Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025320.html">Virtual Gateway</a></div>
</div>
</div>

View File

@ -1,29 +0,0 @@
<a name="en-dc_topic_0055025327"></a><a name="en-dc_topic_0055025327"></a>
<h1 class="topictitle1">Virtual Interface</h1>
<div id="body1495543735580"><p id="en-dc_topic_0055025327__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025328.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025329.html">Creating a Virtual Interface</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025330.html">Querying the Virtual Interface List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025331.html">Deleting a Virtual Interface</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025332.html">Querying a Virtual Interface</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025333.html">Updating a Virtual Interface</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025309.html">APIs</a></div>
</div>
</div>

View File

@ -1,71 +0,0 @@
<a name="en-dc_topic_0055025331"></a><a name="en-dc_topic_0055025331"></a>
<h1 class="topictitle1">Deleting a Virtual Interface</h1>
<div id="body1495543735580"><div class="section" id="en-dc_topic_0055025331__section235045714306"><h4 class="sectiontitle">Function</h4><p id="en-dc_topic_0055025331__p6205567314306">This API is used to delete a virtual interface.</p>
</div>
<div class="section" id="en-dc_topic_0055025331__section4104188114306"><a name="en-dc_topic_0055025331__section4104188114306"></a><a name="section4104188114306"></a><h4 class="sectiontitle">URI</h4><p id="en-dc_topic_0055025331__p1072424213378">DELETE /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025331__table640636113810" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-dc_topic_0055025331__row1546856113814"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.5.1.1"><p id="en-dc_topic_0055025331__p12468664381">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.3.2.5.1.2"><p id="en-dc_topic_0055025331__p346866153810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.3.2.5.1.3"><p id="en-dc_topic_0055025331__p04683613389">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47%" id="mcps1.3.2.3.2.5.1.4"><p id="en-dc_topic_0055025331__p13468206123813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025331__row12468166143815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-dc_topic_0055025331__p24687693816">virtual_interface_id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-dc_topic_0055025331__p8468136203815">String</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-dc_topic_0055025331__p44681561384">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-dc_topic_0055025331__p246813663813">Specifies the virtual interface ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025331__section3850154614306"><h4 class="sectiontitle">Request</h4><p id="en-dc_topic_0055025331__p292833465016"><a href="#en-dc_topic_0055025331__table5224055914306">Table 2</a> lists the request parameter.</p>
<div class="tablenoborder"><a name="en-dc_topic_0055025331__table5224055914306"></a><a name="table5224055914306"></a><table cellpadding="4" cellspacing="0" summary="" id="en-dc_topic_0055025331__table5224055914306" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-dc_topic_0055025331__row6052323214306"><th align="left" class="cellrowborder" valign="top" width="24.84%" id="mcps1.3.3.3.2.5.1.1"><p id="en-dc_topic_0055025331__p1875992714306">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.22%" id="mcps1.3.3.3.2.5.1.2"><p id="en-dc_topic_0055025331__p523663814306">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.509999999999998%" id="mcps1.3.3.3.2.5.1.3"><p id="en-dc_topic_0055025331__p99311514306">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.43%" id="mcps1.3.3.3.2.5.1.4"><p id="en-dc_topic_0055025331__p6490218014306">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-dc_topic_0055025331__row2775932614306"><td class="cellrowborder" valign="top" width="24.84%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-dc_topic_0055025331__p4251721614306">virtual_interface_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.22%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-dc_topic_0055025331__p6380017614306">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.509999999999998%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-dc_topic_0055025331__p1079430814306">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46.43%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-dc_topic_0055025331__p4809318514306">Specifies the virtual interface ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-dc_topic_0055025331__section1670969814306"><h4 class="sectiontitle">Response</h4><p id="en-dc_topic_0055025331__p1427264014306">None</p>
</div>
<div class="section" id="en-dc_topic_0055025331__section3828902514306"><h4 class="sectiontitle">Examples</h4><ul id="en-dc_topic_0055025331__ul65471727518"><li id="en-dc_topic_0055025331__li4547172175117">Example request</li></ul>
<pre class="screen" id="en-dc_topic_0055025331__screen2453856014306">DELETE /v2.0/dcaas/virtual-interfaces/{virtual_interface_id}</pre>
</div>
<ul id="en-dc_topic_0055025331__ul144517611313"><li id="en-dc_topic_0055025331__li13451067132">Response example<p id="en-dc_topic_0055025331__p15690111191318"><a name="en-dc_topic_0055025331__li13451067132"></a><a name="li13451067132"></a>None</p>
</li></ul>
<div class="section" id="en-dc_topic_0055025331__section6289309617342"><h4 class="sectiontitle">Status Codes</h4><p id="en-dc_topic_0055025331__p176816317298">For details, see <a href="en-dc_topic_0055025342.html">Common Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025327.html">Virtual Interface</a></div>
</div>
</div>

View File

@ -1,29 +0,0 @@
<a name="en-dc_topic_0055025334"></a><a name="en-dc_topic_0055025334"></a>
<h1 class="topictitle1">Direct Connect Endpoint Group</h1>
<div id="body1538012995871"><p id="en-dc_topic_0055025334__en-us_topic_0070658757_p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025335.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025336.html">Creating an Endpoint Group</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025337.html">Querying the Direct Connect Endpoint Group List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025338.html">Deleting an Endpoint Group</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025339.html">Querying a Direct Connect Endpoint Group</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025340.html">Updating a Direct Connect Endpoint Group</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025309.html">APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -1,13 +0,0 @@
<a name="en-dc_topic_0055025341"></a><a name="en-dc_topic_0055025341"></a>
<h1 class="topictitle1">Public Parameters</h1>
<div id="body1538035975232"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025342.html">Common Status Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025343.html">Error Codes</a></strong><br>
</li>
</ul>
</div>

File diff suppressed because one or more lines are too long

View File

@ -1,8 +1,8 @@
<a name="en-dc_topic_0055025300"></a><a name="en-dc_topic_0055025300"></a>
<a name="en-us_topic_0055025300"></a><a name="en-us_topic_0055025300"></a>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body1537951352085"><p id="en-dc_topic_0055025300__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="en-dc_topic_0055025300__en-us_topic_0020507759_i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="en-dc_topic_0055025300__en-us_topic_0020507759_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="en-dc_topic_0055025300__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="en-dc_topic_0055025300__en-us_topic_0020507759_b3082532510259">Application/json</strong>.</p>
<p id="en-dc_topic_0055025300__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 id="body1537951352085"><p id="en-us_topic_0055025300__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="en-us_topic_0055025300__en-us_topic_0020507759_i1385069210259">https://Endpoint/uri</em>. In the URL, <strong id="en-us_topic_0055025300__en-us_topic_0020507759_b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
<p id="en-us_topic_0055025300__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="en-us_topic_0055025300__en-us_topic_0020507759_b3082532510259">application/json</strong>.</p>
<p id="en-us_topic_0055025300__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>

View File

@ -0,0 +1,64 @@
<a name="en-us_topic_0055025301"></a><a name="en-us_topic_0055025301"></a>
<h1 class="topictitle1">API Overview</h1>
<div id="body1537951352085"><p id="en-us_topic_0055025301__p980163214216">Direct Connect APIs allow you to use all Direct Connect functions.</p>
<div class="section" id="en-us_topic_0055025301__section1447420297455"><h4 class="sectiontitle">API v2.0</h4>
<div class="tablenoborder"><a name="en-us_topic_0055025301__table5876102613294"></a><a name="table5876102613294"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025301__table5876102613294" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Direct Connect APIs</caption><thead align="left"><tr id="en-us_topic_0055025301__row3878122616298"><th align="left" class="cellrowborder" valign="top" width="22.89%" id="mcps1.3.2.2.2.3.1.1"><p id="en-us_topic_0055025301__p68781126182914"><strong id="en-us_topic_0055025301__b15371541692">Subcategory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="77.11%" id="mcps1.3.2.2.2.3.1.2"><p id="en-us_topic_0055025301__p158781726112914"><strong id="en-us_topic_0055025301__b1846114441191">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0055025301__row148781026122919"><td class="cellrowborder" valign="top" width="22.89%" headers="mcps1.3.2.2.2.3.1.1 "><p id="en-us_topic_0055025301__p128788265295">Connection APIs</p>
</td>
<td class="cellrowborder" valign="top" width="77.11%" headers="mcps1.3.2.2.2.3.1.2 "><p id="en-us_topic_0055025301__p155621015155120">Used to manage connections, including the API used to create a hosted connection, the APIs used to query, delete, and update a connection, and the API to query the connection list.</p>
</td>
</tr>
<tr id="en-us_topic_0055025301__row1987820263297"><td class="cellrowborder" valign="top" width="22.89%" headers="mcps1.3.2.2.2.3.1.1 "><p id="en-us_topic_0055025301__p8939172693215">Virtual gateway APIs</p>
</td>
<td class="cellrowborder" valign="top" width="77.11%" headers="mcps1.3.2.2.2.3.1.2 "><p id="en-us_topic_0055025301__p49241952">Used to manage virtual gateways, including the APIs used to create, delete, query, and update a virtual gateway, and the API to query the virtual gateway list.</p>
</td>
</tr>
<tr id="en-us_topic_0055025301__row87746166614"><td class="cellrowborder" valign="top" width="22.89%" headers="mcps1.3.2.2.2.3.1.1 "><p id="en-us_topic_0055025301__p73349397495">Virtual interface APIs</p>
</td>
<td class="cellrowborder" valign="top" width="77.11%" headers="mcps1.3.2.2.2.3.1.2 "><p id="en-us_topic_0055025301__p19860558104553">Used to manage virtual interfaces, including the APIs used to create, delete, query, and update a virtual interface, and the API to query the virtual interface list.</p>
</td>
</tr>
<tr id="en-us_topic_0055025301__row816313459617"><td class="cellrowborder" valign="top" width="22.89%" headers="mcps1.3.2.2.2.3.1.1 "><p id="en-us_topic_0055025301__p1216317451267">Direct Connect endpoint group APIs</p>
</td>
<td class="cellrowborder" valign="top" width="77.11%" headers="mcps1.3.2.2.2.3.1.2 "><p id="en-us_topic_0055025301__p8781829204012">Used to manage Direct Connect endpoint groups, including the APIs used to create, delete, query, and update an endpoint group, and the API used to query the endpoint group list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-us_topic_0055025301__section17651666916"><h4 class="sectiontitle">API v3</h4>
<div class="tablenoborder"><a name="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_table420812113211"></a><a name="en-us_topic_0178454981_en-us_topic_0173706804_table420812113211"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_table420812113211" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Direct Connect APIs</caption><thead align="left"><tr id="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_row1527972153211"><th align="left" class="cellrowborder" valign="top" width="22.89%" id="mcps1.3.3.2.2.3.1.1"><p id="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_p427918210322"><strong id="en-us_topic_0055025301__b17173155391312">Subcategory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="77.11%" id="mcps1.3.3.2.2.3.1.2"><p id="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_p12279121173212"><strong id="en-us_topic_0055025301__b1415545671318">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_row1227932183218"><td class="cellrowborder" valign="top" width="22.89%" headers="mcps1.3.3.2.2.3.1.1 "><p id="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_p11201229163219">Connection APIs</p>
</td>
<td class="cellrowborder" valign="top" width="77.11%" headers="mcps1.3.3.2.2.3.1.2 "><p id="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_p1279521143211">APIs for querying connection details, updating connection information, deleting a connection, querying the connection list, querying the hosted connection list, creating a hosted connection, querying hosted connection details, updating hosted connection information, and deleting a hosted connection</p>
</td>
</tr>
<tr id="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_row227972163219"><td class="cellrowborder" valign="top" width="22.89%" headers="mcps1.3.3.2.2.3.1.1 "><p id="en-us_topic_0055025301__en-us_topic_0178454981_en-us_topic_0173706804_p2686535123212">Virtual gateway APIs</p>
</td>
<td class="cellrowborder" valign="top" width="77.11%" headers="mcps1.3.3.2.2.3.1.2 "><p id="en-us_topic_0055025301__p885912540916">APIs for querying virtual gateway details, updating virtual gateway information, deleting a virtual gateway, querying the virtual gateway list, and creating a virtual gateway</p>
</td>
</tr>
<tr id="en-us_topic_0055025301__en-us_topic_0178454981_row393263416215"><td class="cellrowborder" valign="top" width="22.89%" headers="mcps1.3.3.2.2.3.1.1 "><p id="en-us_topic_0055025301__en-us_topic_0178454981_p149326341827">Virtual interface APIs</p>
</td>
<td class="cellrowborder" valign="top" width="77.11%" headers="mcps1.3.3.2.2.3.1.2 "><p id="en-us_topic_0055025301__p1485914548916">APIs for querying virtual interface details, updating virtual interface information, deleting a virtual interface, querying the virtual interface list, and creating a virtual interface</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div></div>

View File

@ -1,6 +1,6 @@
<a name="en-dc_topic_0055025308"></a><a name="en-dc_topic_0055025308"></a>
<a name="en-us_topic_0055025308"></a><a name="en-us_topic_0055025308"></a>
<h1 class="topictitle1">API Usage</h1>
<div id="body1539745469192"><p id="en-dc_topic_0055025308__p8060118">Direct Connect has independent endpoints. When API calls are made to Direct Connect, the Direct Connect APIs are used. Therefore, you need pay special attention to the service endpoints used when you make calls to the Direct Connect APIs.</p>
<div id="body1539745469192"><p id="en-us_topic_0055025308__p8060118">Direct Connect has independent endpoints. When API calls are made to Direct Connect, the Direct Connect APIs are used. Therefore, you need pay special attention to the service endpoints used when you make calls to the Direct Connect APIs.</p>
</div>

View File

@ -0,0 +1,19 @@
<a name="en-us_topic_0055025309"></a><a name="en-us_topic_0055025309"></a>
<h1 class="topictitle1">APIs v2.0</h1>
<div id="body1539589976314"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0055025310.html">API Version</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0055025313.html">Connection</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0055025320.html">Virtual Gateway</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0055025327.html">Virtual Interface</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0055025334.html">Direct Connect Endpoint Group</a></strong><br>
</li>
</ul>
</div>

View File

@ -1,17 +1,17 @@
<a name="en-dc_topic_0055025310"></a><a name="en-dc_topic_0055025310"></a>
<a name="en-us_topic_0055025310"></a><a name="en-us_topic_0055025310"></a>
<h1 class="topictitle1">Obtaining the API Version Information</h1>
<h1 class="topictitle1">API Version</h1>
<div id="body1539740810917"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025311.html">Querying All API Versions</a></strong><br>
<li class="ulchildlink"><strong><a href="en-us_topic_0055025311.html">Querying All API Versions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-dc_topic_0055025312.html">Querying a Specified API Version</a></strong><br>
<li class="ulchildlink"><strong><a href="en-us_topic_0055025312.html">Querying a Specified API Version</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-dc_topic_0055025309.html">APIs</a></div>
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0055025309.html">APIs v2.0</a></div>
</div>
</div>

Some files were not shown because too many files have changed in this diff Show More