doc-exports/docs/plas/api-ref/en-us_topic_0218811269.html
Mei, Sai 46435e6aee PLAS API version1
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Mei, Sai <meisai@huawei.com>
Co-committed-by: Mei, Sai <meisai@huawei.com>
2022-11-29 13:00:08 +00:00

239 lines
18 KiB
HTML

<a name="en-us_topic_0218811269"></a><a name="en-us_topic_0218811269"></a>
<h1 class="topictitle1">Modifying a PLAS Connector</h1>
<div id="body44544308"><div class="section" id="en-us_topic_0218811269__section35862949"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0218811269__p3306121484510">This API is used to modify a PLAS connector based on the connector ID. Based on the URL returned, you can query the modification progress.</p>
</div>
<div class="section" id="en-us_topic_0218811269__section54331087"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0218811269__ul63215968"><li id="en-us_topic_0218811269__li32072800">URI format<p id="en-us_topic_0218811269__p20219750"><a name="en-us_topic_0218811269__li32072800"></a><a name="li32072800"></a>PUT /v1.0/plasconnector/connectors/{connector_id}</p>
</li><li id="en-us_topic_0218811269__li47760026">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811269__table27187053" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811269__row1071166"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="en-us_topic_0218811269__p19655582">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="en-us_topic_0218811269__p48598282">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="en-us_topic_0218811269__p44146795">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.980000000000004%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="en-us_topic_0218811269__p19120681">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811269__row5271339"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0218811269__p24325338">connector_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0218811269__p24195357">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0218811269__p13666909">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.980000000000004%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0218811269__p33277825">Indicates the PLAS connector ID.</p>
<p id="en-us_topic_0218811269__p31064972">The value is a string of 1 to 36 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0218811269__section19217739"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0218811269__ul33234818"><li id="en-us_topic_0218811269__li30677911">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811269__table7665744" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811269__row25676248"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0218811269__p66510236">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0218811269__p18620036">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0218811269__p31827961">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.980000000000004%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0218811269__p27928034">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811269__row47578280"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811269__p28635442">PlasConnector</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811269__p37769448">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811269__p39426484">PlasConnectorUpdateReq object</p>
</td>
<td class="cellrowborder" valign="top" width="48.980000000000004%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811269__p39428603">Indicates information about the PLAS connector.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<p class="msonormal" id="en-us_topic_0218811269__p19313113">The PlasConnectorUpdateReq object has the following attributes.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811269__table39600295" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811269__row3707986"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.3.4.1.5.1.1"><p id="en-us_topic_0218811269__p31911441">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.3.4.1.5.1.2"><p id="en-us_topic_0218811269__p34689953">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.3.4.1.5.1.3"><p id="en-us_topic_0218811269__p58422826">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.980000000000004%" id="mcps1.3.3.4.1.5.1.4"><p id="en-us_topic_0218811269__p34628435">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811269__row53439812"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.4.1.5.1.1 "><p id="en-us_topic_0218811269__p33657510">connector</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.4.1.5.1.2 "><p id="en-us_topic_0218811269__p41903776">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.4.1.5.1.3 "><p id="en-us_topic_0218811269__p38762715">PlasConnectorUpdateModel object</p>
</td>
<td class="cellrowborder" valign="top" width="48.980000000000004%" headers="mcps1.3.3.4.1.5.1.4 "><p id="en-us_topic_0218811269__p52772223">Indicates the request for modifying a PLAS connector.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p class="msonormal" id="en-us_topic_0218811269__p5187959">The PlasConnectorUpdateModel object has the following attributes.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811269__table46691634" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811269__row33365711"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.3.6.1.5.1.1"><p id="en-us_topic_0218811269__p18268036">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.3.6.1.5.1.2"><p id="en-us_topic_0218811269__p3315925">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.3.6.1.5.1.3"><p id="en-us_topic_0218811269__p154540">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.980000000000004%" id="mcps1.3.3.6.1.5.1.4"><p id="en-us_topic_0218811269__p12517742">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811269__row7304197"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.6.1.5.1.1 "><p id="en-us_topic_0218811269__p54769113">name</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.6.1.5.1.2 "><p id="en-us_topic_0218811269__p7113169">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.6.1.5.1.3 "><p id="en-us_topic_0218811269__p39295830">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.980000000000004%" headers="mcps1.3.3.6.1.5.1.4 "><p id="en-us_topic_0218811269__p28845647">Indicates the name of the PLAS connector name. The name can consist of letters, digits, underscores (_), and hyphens (-).</p>
<p id="en-us_topic_0218811269__p58284235">The value is a string of 1 to 128 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811269__row54796069"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.6.1.5.1.1 "><p id="en-us_topic_0218811269__p9296575">description</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.6.1.5.1.2 "><p id="en-us_topic_0218811269__p14825093">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.6.1.5.1.3 "><p id="en-us_topic_0218811269__p59981921">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.980000000000004%" headers="mcps1.3.3.6.1.5.1.4 "><p id="en-us_topic_0218811269__p26697400">Indicates the connector description.</p>
<p id="en-us_topic_0218811269__p38950014">The value is a string of 0 to 255 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811269__row15005812"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.6.1.5.1.1 "><p id="en-us_topic_0218811269__p7511293">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.6.1.5.1.2 "><p id="en-us_topic_0218811269__p4435002">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.6.1.5.1.3 "><p id="en-us_topic_0218811269__p23690900">int32</p>
</td>
<td class="cellrowborder" valign="top" width="48.980000000000004%" headers="mcps1.3.3.6.1.5.1.4 "><p id="en-us_topic_0218811269__p39914738">Indicates the bandwidth in Mbit/s.</p>
<p id="en-us_topic_0218811269__p23688326">Value range:</p>
<ul id="en-us_topic_0218811269__ul11868349"><li id="en-us_topic_0218811269__li39706278">10</li><li id="en-us_topic_0218811269__li21812188">50</li><li id="en-us_topic_0218811269__li62091967">100</li><li id="en-us_topic_0218811269__li21956792">150</li><li id="en-us_topic_0218811269__li63393400">200</li><li id="en-us_topic_0218811269__li33669688">300</li><li id="en-us_topic_0218811269__li34591737">400</li><li id="en-us_topic_0218811269__li42890180">500</li><li id="en-us_topic_0218811269__li50467307">600</li><li id="en-us_topic_0218811269__li51552581">1000</li></ul>
</td>
</tr>
<tr id="en-us_topic_0218811269__row61320053"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.6.1.5.1.1 "><p id="en-us_topic_0218811269__p868416">lineId</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.6.1.5.1.2 "><p id="en-us_topic_0218811269__p3232884">No</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.6.1.5.1.3 "><p id="en-us_topic_0218811269__p60537015">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.980000000000004%" headers="mcps1.3.3.6.1.5.1.4 "><p id="en-us_topic_0218811269__p4551220">Indicates the line ID, which is assigned by the CCR.</p>
<p id="en-us_topic_0218811269__p40960983">The value is a string of 1 to 36 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<ul id="en-us_topic_0218811269__ul33104529"><li id="en-us_topic_0218811269__li29505307">Sample request<pre class="codeblock" id="en-us_topic_0218811269__codeblock64221174">PUT /v1.0/plasconnector/connectors/e7b778a7-5d94-4263-813f-4aec18473a5a HTTP/1.1 </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock41119660">Content-Type:application/json </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock34532620">Accept:application/json; </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock42358129">X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock45678842">{ </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock8456402"> "connector" : { </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock8998761"> "name" :"modifyLiu", </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock13879993"> "description" : "modifyLiu", </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock57811073"> "bandwidth" : 11, </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock50537611"> "networkInfo": { </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock52185321"> "lineId":"UUID" </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock67014706"> } </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock66261449"> } </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock59482134"> } </pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0218811269__section38741931"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0218811269__ul53323550"><li id="en-us_topic_0218811269__li10149907">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811269__table24240307" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811269__row9545902"><th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0218811269__p35020602">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0218811269__p18096510">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0218811269__p56531235">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.980000000000004%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0218811269__p15627345">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811269__row57855407"><td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811269__p55776357">location</p>
</td>
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811269__p21591068">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811269__p4046075">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.980000000000004%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811269__p59296683">Indicates the URL, through which you can query the operation progress.</p>
<p id="en-us_topic_0218811269__p63908105">The value is a string of 1 to 255 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0218811269__li38302036">Sample response<pre class="codeblock" id="en-us_topic_0218811269__codeblock9174005">HTTP/1.1 200 OK </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock15457181">Content-Type:application/json </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock4896901">Cache-Control:no-cache </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock44072110"></pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock61104673">HTTP/1.1 202 OK </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock13071152">Content-Type:application/json </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock50531506">Cache-Control:no-cache </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock52130378"></pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock66520224">{ </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock61811109"> "location":"/v1.0/plasconnector/connector/e7b778a7-5d94-4263-813f-4aec18473a5a/operations/95a44e38-5d61-44ca-a5c4-f241812fbd51" </pre>
<pre class="codeblock" id="en-us_topic_0218811269__codeblock19429074">} </pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0218811269__section13133063"><h4 class="sectiontitle">Returned Value</h4><ul id="en-us_topic_0218811269__ul30251185"><li id="en-us_topic_0218811269__li3825212">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811269__table34426916" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811269__row13289771"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="en-us_topic_0218811269__p2729681">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="en-us_topic_0218811269__p19777615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811269__row58483022"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="en-us_topic_0218811269__p39504374">200 OK</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="en-us_topic_0218811269__p45737710">The PLAS connector is successfully modified.</p>
</td>
</tr>
<tr id="en-us_topic_0218811269__row8986207"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="en-us_topic_0218811269__p56794195">202 OK</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="en-us_topic_0218811269__p36927083">The request has been accepted for processing, but the processing has not been completed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0218811269__li63908296">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811269__table38303760" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811269__row28699416"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="en-us_topic_0218811269__p42951331">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="en-us_topic_0218811269__p56505791">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811269__row13566355"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0218811269__p25133000">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0218811269__p22507142">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0218811269__row1237687"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0218811269__p33143828">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0218811269__p295566">The server encountered an unexpected condition which prevented it from fulfilling the request.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0218811264.html">PLAS APIs</a></div>
</div>
</div>