doc-exports/docs/dc/api-ref/en-us_topic_0055025319.html
Qin Ying, Fan 62ab8a5fe2 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>
2024-03-11 15:10:40 +00:00

194 lines
14 KiB
HTML

<a name="en-us_topic_0055025319"></a><a name="en-us_topic_0055025319"></a>
<h1 class="topictitle1">Updating a Connection</h1>
<div id="body43843091"><div class="section" id="en-us_topic_0055025319__section10267951"><a name="en-us_topic_0055025319__section10267951"></a><a name="section10267951"></a><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0055025319__p14291510125814">This API is used to update a connection.</p>
</div>
<div class="section" id="en-us_topic_0055025319__section25302698"><h4 class="sectiontitle">URI</h4><p id="en-us_topic_0055025319__p120118258388">PUT /v2.0/dcaas/direct-connects/{direct_connect_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025319__table183245150407" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0055025319__row1329191584012"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="en-us_topic_0055025319__p8332215134011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.3.2.5.1.2"><p id="en-us_topic_0055025319__p153354156404"><strong id="en-us_topic_0055025319__b842352706165439">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.2.3.2.5.1.3"><p id="en-us_topic_0055025319__p2339151519405"><strong id="en-us_topic_0055025319__b842352706192549">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.2.3.2.5.1.4"><p id="en-us_topic_0055025319__p3341141516405"><strong id="en-us_topic_0055025319__b84235270615331">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0055025319__row7342191504013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="en-us_topic_0055025319__p2344315174014">direct_connect_id</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.5.1.2 "><p id="en-us_topic_0055025319__p234713152402">String</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.2.3.2.5.1.3 "><p id="en-us_topic_0055025319__p13511015184019">No</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.2.3.2.5.1.4 "><p id="en-us_topic_0055025319__p143531415154018">Specifies the connection ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-us_topic_0055025319__section36252627"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0055025319__p21078426103641"><a href="#en-us_topic_0055025319__table7364283175427">Table 2</a> lists the request parameter.</p>
<div class="tablenoborder"><a name="en-us_topic_0055025319__table7364283175427"></a><a name="table7364283175427"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025319__table7364283175427" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter</caption><thead align="left"><tr id="en-us_topic_0055025319__row28171119175427"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="en-us_topic_0055025319__p8323660175427">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.3.2.5.1.2"><p id="en-us_topic_0055025319__p46855411175427"><strong id="en-us_topic_0055025319__b1911302111">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.3.2.5.1.3"><p id="en-us_topic_0055025319__p60815106175427"><strong id="en-us_topic_0055025319__b1556007572">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.3.3.2.5.1.4"><p id="en-us_topic_0055025319__p43025320175427">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0055025319__row49466658175427"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="en-us_topic_0055025319__p4415550175427">direct_connect</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.3.2.5.1.2 "><p id="en-us_topic_0055025319__p1100763175427">Dictionary</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.3.2.5.1.3 "><p id="en-us_topic_0055025319__p15674469175427">No</p>
</td>
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.3.3.2.5.1.4 "><p id="en-us_topic_0055025319__p228188175427">Specifies the <strong id="en-us_topic_0055025319__b842352706172852">direct_connect</strong> object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025319__table125648759846" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of field <strong id="en-us_topic_0055025319__b8423527069345">direct_connect</strong></caption><thead align="left"><tr id="en-us_topic_0055025319__row265942339846"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.3.4.2.5.1.1"><p id="en-us_topic_0055025319__p351661709915"><strong id="en-us_topic_0055025319__b8423527069918">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.3.4.2.5.1.2"><p id="en-us_topic_0055025319__p89913189915"><strong id="en-us_topic_0055025319__b1140766185">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.3.4.2.5.1.3"><p id="en-us_topic_0055025319__p209180099915"><strong id="en-us_topic_0055025319__b815314795">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.43434343434344%" id="mcps1.3.3.4.2.5.1.4"><p id="en-us_topic_0055025319__p132751689915"><strong id="en-us_topic_0055025319__b1060505731">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0055025319__row5271981314254"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025319__p5257963714254">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025319__p3109221814254">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025319__p3544171514254">No</p>
</td>
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025319__p5220666514254">Provides supplementary information about the connection.</p>
<p id="en-us_topic_0055025319__p1731675813314"><span id="en-us_topic_0055025319__text243011117548">Angle brackets (&lt;&gt;) are not allowed.</span></p>
</td>
</tr>
<tr id="en-us_topic_0055025319__row2822737814254"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025319__p793298914254">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025319__p3859237714254">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025319__p3897482914254">No</p>
</td>
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025319__p284461014254">Specifies the connection name.</p>
<p id="en-us_topic_0055025319__p82783530282"><span id="en-us_topic_0055025319__text15699204710333">Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed.</span></p>
</td>
</tr>
<tr id="en-us_topic_0055025319__row24309452205237"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025319__p46653157205251">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025319__p20809410205251">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025319__p7840639205251">No</p>
</td>
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025319__p31112004205251">Specifies the bandwidth of the connection in Mbit/s.</p>
</td>
</tr>
<tr id="en-us_topic_0055025319__row21061467142619"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.1 "><p id="en-us_topic_0055025319__p26051377142619">provider_status</p>
</td>
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.4.2.5.1.2 "><p id="en-us_topic_0055025319__p29786826142619">String</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.4.2.5.1.3 "><p id="en-us_topic_0055025319__p63922711142619">No</p>
</td>
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.3.4.2.5.1.4 "><p id="en-us_topic_0055025319__p7663085204619">Specifies the status of the carrier's leased line.</p>
<p id="en-us_topic_0055025319__p10357121142619">The value can be <strong id="en-us_topic_0055025319__b842352706171439">ACTIVE</strong> or <strong id="en-us_topic_0055025319__b842352706171443">DOWN</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="en-us_topic_0055025319__section57838187"><a name="en-us_topic_0055025319__section57838187"></a><a name="section57838187"></a><h4 class="sectiontitle">Response</h4><p id="en-us_topic_0055025319__p42735278143140"><a href="#en-us_topic_0055025319__table49073182143140">Table 4</a> lists the response parameter.</p>
<div class="tablenoborder"><a name="en-us_topic_0055025319__table49073182143140"></a><a name="table49073182143140"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0055025319__table49073182143140" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameter</caption><thead align="left"><tr id="en-us_topic_0055025319__row41888921143140"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.3.2.4.1.1"><p id="en-us_topic_0055025319__p37559451143140">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.3.2.4.1.2"><p id="en-us_topic_0055025319__p3814541143140"><strong id="en-us_topic_0055025319__b84235270693914">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.3.2.4.1.3"><p id="en-us_topic_0055025319__p40542413143140">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0055025319__row62710001143140"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.3.2.4.1.1 "><p id="en-us_topic_0055025319__p46345314143140">direct_connect</p>
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.3.2.4.1.2 "><p id="en-us_topic_0055025319__p1342792143140">Dictionary</p>
</td>
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.3.2.4.1.3 "><p id="en-us_topic_0055025319__p39371911143140">Specifies the <strong id="en-us_topic_0055025319__b842352706172942">direct_connect</strong> object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="en-us_topic_0055025319__p140733182318">For details about the <strong id="en-us_topic_0055025319__b1229013352523">direct_connect</strong> field, see <a href="en-us_topic_0055025314.html#en-us_topic_0055025314__en-us_topic_0070676569_table49902238182444">Table 1</a>.</p>
</div>
<div class="section" id="en-us_topic_0055025319__section5055526711495"><h4 class="sectiontitle">Examples</h4><ul id="en-us_topic_0055025319__ul1098014354110"><li id="en-us_topic_0055025319__li149809318411">Example request<pre class="screen" id="en-us_topic_0055025319__screen4017959713452">PUT /v2.0/dcaas/direct-connects/{direct_connect_id}
{
"direct_connect" : {
"name" : "direct connect1",
"description" : "New description"
}
}</pre>
</li></ul>
</div>
<ul id="en-us_topic_0055025319__ul3940201611417"><li id="en-us_topic_0055025319__li19940216124110"><a name="en-us_topic_0055025319__li19940216124110"></a><a name="li19940216124110"></a>Example response<pre class="screen" id="en-us_topic_0055025319__screen192561423382">{
"direct_connects" : {
"name": "direct connect",
"id": "294ebeeb-62dd-4ece-99f5-73055df6d835",
"description": "",
"tenant_id": "0605768ad980d5762f8ac010b919754c",
"type": "hosted",
"hosting_id": "0e85c677-6eb5-4ef6-87a7-74d4586be895",
"vlan": 228,
"charge_mode": null,
"port_type": "1G",
"bandwidth": 2,
"location": "Biere",
"peer_location": "",
"device_id": "18.8.215.131",
"interface_name": "Eth-Trunk2",
"redundant_id": null,
"provider": "OTC",
"provider_status": "ACTIVE",
"status": "ACTIVE",
"apply_time": "2022-12-08T01:59:36.000Z",
"reason": null,
"admin_state_up": true,
"order_id": null,
"product_id": null,
"spec_code": null,
"applicant": null,
"mobile": null,
"email": null,
"create_time": "2022-12-08T01:59:36.000Z",
"region_id": null,
"service_key": null,
"cable_label": null,
"peer_port_type": null,
"peer_provider": null,
"onestop_product_id": null,
"building_line_product_id": null,
"last_onestop_product_id": null,
"period_type": null,
"period_num": null,
"vgw_type": "default",
"lag_id": null
}
}</pre>
</li></ul>
<div class="section" id="en-us_topic_0055025319__section178941713364"><h4 class="sectiontitle">Status Codes</h4><p id="en-us_topic_0055025319__p176816317298">For details, see <a href="en-us_topic_0055025342.html">Common Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0055025313.html">Connection</a></div>
</div>
</div>