vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/plas/api-ref/en-us_topic_0218811266.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

443 lines
37 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="en-us_topic_0218811266"></a><a name="en-us_topic_0218811266"></a>
<h1 class="topictitle1">Querying PLAS Connectors</h1>
<div id="body40290784"><div class="section" id="en-us_topic_0218811266__section53080699"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0218811266__p972019279419">This API is used to query PLAS connectors.</p>
</div>
<div class="section" id="en-us_topic_0218811266__section7964250"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0218811266__ul6024691"><li id="en-us_topic_0218811266__li54222225">URI format<p id="en-us_topic_0218811266__p18237983"><a name="en-us_topic_0218811266__li54222225"></a><a name="li54222225"></a>GET /v1.0/plasconnector/connectors</p>
</li><li id="en-us_topic_0218811266__li29924127">Example<pre class="screen" id="en-us_topic_0218811266__screen881688">/v1.0/plasconnector/connectors?name=plasconnector-1&amp;pageSize=10&amp;pageNum=1</pre>
</li><li id="en-us_topic_0218811266__li7935197">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811266__table4307909" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811266__row29917273"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="en-us_topic_0218811266__p7380066">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="en-us_topic_0218811266__p60914443">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="en-us_topic_0218811266__p35122812">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.97510248975102%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="en-us_topic_0218811266__p26375518">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811266__row56042200"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="en-us_topic_0218811266__p43124371">name</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="en-us_topic_0218811266__p3413175">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="en-us_topic_0218811266__p8031722">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="en-us_topic_0218811266__p46589783">Indicates the PLAS connector name, which can be used for fuzzy match.</p>
<p id="en-us_topic_0218811266__p16654866">The value is a string of 1 to 128 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row15676068"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="en-us_topic_0218811266__p61801977">ID</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="en-us_topic_0218811266__p39904255">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="en-us_topic_0218811266__p11019229">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="en-us_topic_0218811266__p20142396">Indicates the PLAS connector id, which can be used for fuzzy match.</p>
<p id="en-us_topic_0218811266__p47063844">The value is a string of 1 to 36 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row20921412"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="en-us_topic_0218811266__p16912796">pageSize</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="en-us_topic_0218811266__p27759212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="en-us_topic_0218811266__p33903709">int32</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="en-us_topic_0218811266__p61845910">Indicates the number of records on each page. <strong id="en-us_topic_0218811266__b19742286">pageSize</strong> and <strong id="en-us_topic_0218811266__b43462848">pageNum</strong> determine a specific page.</p>
<p id="en-us_topic_0218811266__p55621319">Value range: 10–100</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row30829827"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="en-us_topic_0218811266__p14188038">pageNum</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="en-us_topic_0218811266__p8380401">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="en-us_topic_0218811266__p7723885">int32</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="en-us_topic_0218811266__p21654945">Indicates the number of the current page. <strong id="en-us_topic_0218811266__b60676784">pageSize</strong> and <strong id="en-us_topic_0218811266__b9220150">pageNum</strong> determine a specific page.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0218811266__section4569390"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0218811266__ul8634708"><li id="en-us_topic_0218811266__li10603509">Parameter description<p id="en-us_topic_0218811266__p28322722"><a name="en-us_topic_0218811266__li10603509"></a><a name="li10603509"></a>None</p>
</li><li id="en-us_topic_0218811266__li53577906">Sample request<pre class="codeblock" id="en-us_topic_0218811266__codeblock12439112">GET /v1.0/plasconnector/connectors HTTP/1.1 </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock44843148">Content-Type:application/json </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock935151">Accept:application/json; </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock8416362">X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0218811266__section41124512"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0218811266__ul10636725"><li id="en-us_topic_0218811266__li28621662">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811266__table56268372" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811266__row49194147"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0218811266__p25302957">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0218811266__p36273656">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0218811266__p52485036">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.97510248975102%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0218811266__p23429487">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811266__row18740332"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811266__p41571913">totalNum</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811266__p11881774">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811266__p22899652">int32</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811266__p42932530">Indicates the total number of records.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row50848458"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811266__p25084465">pageSize</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811266__p18575747">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811266__p28240554">int32</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811266__p5783566">Indicates the number of records on each page.</p>
<p id="en-us_topic_0218811266__p52052098">Value range: 10–100</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row65815702"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811266__p29471659">currentPage</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811266__p38394164">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811266__p22919578">int32</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811266__p44546500">Indicates the number of the current page.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row65374182"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811266__p60817394">data</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811266__p27261878">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811266__p60728539">List&lt;PlasConnectorDetailModel&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811266__p20064649">Indicates the list of PLAS connector.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<p class="msonormal" id="en-us_topic_0218811266__p46364114">The PlasConnectorDetailModel object has the following attributes.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811266__table14623847" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811266__row52890066"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.4.1.5.1.1"><p id="en-us_topic_0218811266__p56236929">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.4.4.1.5.1.2"><p id="en-us_topic_0218811266__p58897389">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.4.1.5.1.3"><p id="en-us_topic_0218811266__p5959165">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.97510248975102%" id="mcps1.3.4.4.1.5.1.4"><p id="en-us_topic_0218811266__p12930329">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811266__row40723754"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811266__p10289816">id</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811266__p28168778">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811266__p67078569">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811266__p64655004">Indicates the PLAS connector ID.</p>
<p id="en-us_topic_0218811266__p45024129">The value is a string of 1 to 36 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row2563980"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811266__p6355808">tenantId</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811266__p45058433">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811266__p25854422">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811266__p13833415">Indicates the tenant ID.</p>
<p id="en-us_topic_0218811266__p57391878">The value is a string of 1 to 36 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row46764862"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811266__p29857440">name</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811266__p2533591">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811266__p3894347">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811266__p47006691">Indicates the PLAS connector name. The name can consist of letters, digits, underscores (_), and hyphens (-).</p>
<p id="en-us_topic_0218811266__p20407040">The value is a string of 1 to 128 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row49445640"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811266__p45673889">description</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811266__p8597527">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811266__p25311057">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811266__p36929719">Indicates the PLAS connector description.</p>
<p id="en-us_topic_0218811266__p63932023">The value is a string of 0 to 255 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row38517299"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811266__p32893482">bandwidth</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811266__p47126406">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811266__p59142575">int32</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811266__p25819276">Indicates the bandwidth in Mbit/s.</p>
<p id="en-us_topic_0218811266__p31046898">Value range:</p>
<ul id="en-us_topic_0218811266__ul10986630"><li id="en-us_topic_0218811266__li31770809">10</li><li id="en-us_topic_0218811266__li17501828">50</li><li id="en-us_topic_0218811266__li23298728">100</li><li id="en-us_topic_0218811266__li8361967">150</li><li id="en-us_topic_0218811266__li8148840">200</li><li id="en-us_topic_0218811266__li6230702">300</li><li id="en-us_topic_0218811266__li56076321">400</li><li id="en-us_topic_0218811266__li34924842">500</li><li id="en-us_topic_0218811266__li45888122">600</li><li id="en-us_topic_0218811266__li10339914">1000</li></ul>
</td>
</tr>
<tr id="en-us_topic_0218811266__row25950363"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811266__p21604653">cloudInfo</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811266__p5146455">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811266__p14209730">CloudInfo object</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811266__p10137494">Indicates the cloud interconnected with the PLAS connector.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row24128582"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811266__p8258121">networkInfo</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811266__p64928073">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811266__p24682541">NetworkInfo object</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811266__p53128798">Indicates the network interconnected with the PLAS connector.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row8397134"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811266__p9079260">status</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811266__p64331499">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811266__p43468963">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811266__p31325099">Indicates the PLAS Connector status.</p>
<p id="en-us_topic_0218811266__p13490436">Value range:</p>
<ul id="en-us_topic_0218811266__ul54305067"><li id="en-us_topic_0218811266__li18983560">Pending</li><li id="en-us_topic_0218811266__li36634316">Available</li><li id="en-us_topic_0218811266__li61273392">Failed</li><li id="en-us_topic_0218811266__li14589621">Deleting</li></ul>
</td>
</tr>
<tr id="en-us_topic_0218811266__row64197733"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811266__p32633870">createTime</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811266__p26097812">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811266__p33547998">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811266__p33033300">Indicates the creation time. The time must be a UNIX timestamp accurate to milliseconds.</p>
<p id="en-us_topic_0218811266__p28864252">The value is a string of 1 to 36 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p class="msonormal" id="en-us_topic_0218811266__p58451680">The CloudInfo object has the following attributes.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811266__table56303072" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811266__row60463993"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.6.1.5.1.1"><p id="en-us_topic_0218811266__p65745283">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.4.6.1.5.1.2"><p id="en-us_topic_0218811266__p23767697">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.6.1.5.1.3"><p id="en-us_topic_0218811266__p46135308">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.97510248975102%" id="mcps1.3.4.6.1.5.1.4"><p id="en-us_topic_0218811266__p45972443">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811266__row32780391"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.6.1.5.1.1 "><p id="en-us_topic_0218811266__p37965975">provider</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.6.1.5.1.2 "><p id="en-us_topic_0218811266__p55345107">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.6.1.5.1.3 "><p id="en-us_topic_0218811266__p53768708">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.6.1.5.1.4 "><p id="en-us_topic_0218811266__p60298130">Indicates the cloud provider.</p>
<p id="en-us_topic_0218811266__p5812263">Only <strong id="en-us_topic_0218811266__b52310372">OTC</strong> is currently supported.</p>
<p id="en-us_topic_0218811266__p1031307">The value is a string of 1 to 64 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row9281763"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.6.1.5.1.1 "><p id="en-us_topic_0218811266__p13625334">masterLocation</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.6.1.5.1.2 "><p id="en-us_topic_0218811266__p29910278">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.6.1.5.1.3 "><p id="en-us_topic_0218811266__p6813434">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.6.1.5.1.4 "><p id="en-us_topic_0218811266__p15017275">Indicates the primary area that the PCCE connects to.</p>
<p id="en-us_topic_0218811266__p937747">Only <strong id="en-us_topic_0218811266__b8439728">Biere</strong> and <strong id="en-us_topic_0218811266__b8848689">Magdeburg</strong> are currently supported.</p>
<p id="en-us_topic_0218811266__p12529345">The value is a string of 1 to 128 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row45655248"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.6.1.5.1.1 "><p id="en-us_topic_0218811266__p7087640">masterDirectConnectId</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.6.1.5.1.2 "><p id="en-us_topic_0218811266__p37227952">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.6.1.5.1.3 "><p id="en-us_topic_0218811266__p62674112">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.6.1.5.1.4 "><p id="en-us_topic_0218811266__p43438321">Indicates the ID of the Direct Connect link connected to the primary area.</p>
<p id="en-us_topic_0218811266__p55400573">The value is a string of 1 to 36 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row28843114"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.6.1.5.1.1 "><p id="en-us_topic_0218811266__p54590932">slaveLocation</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.6.1.5.1.2 "><p id="en-us_topic_0218811266__p59789399">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.6.1.5.1.3 "><p id="en-us_topic_0218811266__p11103130">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.6.1.5.1.4 "><p id="en-us_topic_0218811266__p26938309">Indicates the secondary area that the PCCE connects to.</p>
<p id="en-us_topic_0218811266__p41118193">Only <strong id="en-us_topic_0218811266__b34519425">Biere</strong> and <strong id="en-us_topic_0218811266__b42239373">Magdeburg</strong> are currently supported.</p>
<p id="en-us_topic_0218811266__p44610037">The value is a string of 1 to 128 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row65946020"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.6.1.5.1.1 "><p id="en-us_topic_0218811266__p40027424">slaveDirectConnectId</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.6.1.5.1.2 "><p id="en-us_topic_0218811266__p20995945">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.6.1.5.1.3 "><p id="en-us_topic_0218811266__p22949990">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.6.1.5.1.4 "><p id="en-us_topic_0218811266__p47009920">Indicates the ID of the Direct Connect link connected to the secondary area.</p>
<p id="en-us_topic_0218811266__p20436099">The value is a string of 1 to 36 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p class="msonormal" id="en-us_topic_0218811266__p49707166">The NetworkInfo object has the following attributes.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811266__table44711314" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811266__row35622116"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.8.1.5.1.1"><p id="en-us_topic_0218811266__p66819120">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.4.8.1.5.1.2"><p id="en-us_topic_0218811266__p43639665">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.8.1.5.1.3"><p id="en-us_topic_0218811266__p45152015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.97510248975102%" id="mcps1.3.4.8.1.5.1.4"><p id="en-us_topic_0218811266__p33434609">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811266__row23848832"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.8.1.5.1.1 "><p id="en-us_topic_0218811266__p52707235">provider</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.8.1.5.1.2 "><p id="en-us_topic_0218811266__p41427651">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.8.1.5.1.3 "><p id="en-us_topic_0218811266__p196551">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.8.1.5.1.4 "><p id="en-us_topic_0218811266__p15920664">Indicates the network provider.</p>
<p id="en-us_topic_0218811266__p9068248">Only <strong id="en-us_topic_0218811266__b14505373">Telekom </strong>is currently supported.</p>
<p id="en-us_topic_0218811266__p63439494">The value is a string of 1 to 64 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row34084542"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.8.1.5.1.1 "><p id="en-us_topic_0218811266__p9384549">networkDomain</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.8.1.5.1.2 "><p id="en-us_topic_0218811266__p21950967">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.8.1.5.1.3 "><p id="en-us_topic_0218811266__p33197918">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.8.1.5.1.4 "><p id="en-us_topic_0218811266__p4676866">Indicates the network domain.</p>
<p id="en-us_topic_0218811266__p42091798">Only <strong id="en-us_topic_0218811266__b43281866">IPLS</strong> is currently supported.</p>
<p id="en-us_topic_0218811266__p53992479">The value is a string of 1 to 128 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row16170271"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.8.1.5.1.1 "><p id="en-us_topic_0218811266__p34723560">masterLocation</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.8.1.5.1.2 "><p id="en-us_topic_0218811266__p61144974">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.8.1.5.1.3 "><p id="en-us_topic_0218811266__p53795832">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.8.1.5.1.4 "><p id="en-us_topic_0218811266__p62495118">Indicates the primary area that the PCCE connects to.</p>
<p id="en-us_topic_0218811266__p25585158">Only <strong id="en-us_topic_0218811266__b28939834">Biere</strong> and <strong id="en-us_topic_0218811266__b59131914">Magdeburg</strong> are currently supported.</p>
<p id="en-us_topic_0218811266__p62425185">The value is a string of 1 to 128 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row24955759"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.8.1.5.1.1 "><p id="en-us_topic_0218811266__p8150621">slaveLocation</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.8.1.5.1.2 "><p id="en-us_topic_0218811266__p56220539">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.8.1.5.1.3 "><p id="en-us_topic_0218811266__p57569777">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.8.1.5.1.4 "><p id="en-us_topic_0218811266__p32640360">Indicates the secondary area that the PCCE connects to.</p>
<p id="en-us_topic_0218811266__p25327787">Only <strong id="en-us_topic_0218811266__b26623495">Biere</strong> and <strong id="en-us_topic_0218811266__b38284870">Magdeburg</strong> are currently supported.</p>
<p id="en-us_topic_0218811266__p9019511">The value is a string of 1 to 128 characters.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row14066741"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.8.1.5.1.1 "><p id="en-us_topic_0218811266__p65664225">lineId</p>
</td>
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.8.1.5.1.2 "><p id="en-us_topic_0218811266__p17201969">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.8.1.5.1.3 "><p id="en-us_topic_0218811266__p51182221">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.8.1.5.1.4 "><p id="en-us_topic_0218811266__p52119262">Indicates the line ID, which is assigned by the CCR.</p>
<p id="en-us_topic_0218811266__p66420182">The value is a string of 1 to 36 characters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<ul id="en-us_topic_0218811266__ul60910732"><li id="en-us_topic_0218811266__li11325681">Sample response<pre class="codeblock" id="en-us_topic_0218811266__codeblock34822270">HTTP/1.1 200 OK </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock44964981">Content-Type:application/json </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock2031645">Cache-Control:no-cache </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock18284808"></pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock30345552">{ </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock4674517"> "totalNum": 1, </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock42070656"> "pageSize": 10, </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock43091586"> "currentPage": 1, </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock52279956"> "data": [{ </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock757559"> "id": "uuid", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock6818037"> "tenantId": "uuid", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock61362333"> "name": "plasconnector-1", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock15390090"> "description":"connector description", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock4293083"> "bandwidth": 50, </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock38637755"> "cloudInfo": { </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock12195482"> "provider": "OTC", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock42650482"> "masterLocation": "Biere", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock48310018"> "masterDirectConnectId": "uuid1", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock32136980"> "slaveLocation": "Magdeburg", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock20797370"> "slaveDirectConnectId": "uuid2" </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock52958603"> }, </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock6865386"> "networkInfo": { </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock61788479"> "provider": "Telekom", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock19225403"> "networkDomain": "IPLS", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock38810903"> "masterLocation": "Biere", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock13753812"> "slaveLocation":"Magdeburg", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock56675452"> "lineId":"UUID" </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock40317022"> }, </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock27308885"> "status": "Available", </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock44453377"> "createTime":"1223445454" </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock64536075"> } </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock43953764"> ] </pre>
<pre class="codeblock" id="en-us_topic_0218811266__codeblock60039557">} </pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0218811266__section34576289"><h4 class="sectiontitle">Returned Value</h4><ul id="en-us_topic_0218811266__ul31365931"><li id="en-us_topic_0218811266__li13857931">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811266__table57612519" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811266__row11997330"><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_0218811266__p32259648">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_0218811266__p62894662">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811266__row61302861"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="en-us_topic_0218811266__p66584700">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_0218811266__p24651644">PLAS connectors are returned in a list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0218811266__li20538210">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811266__table50626165" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811266__row60076778"><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_0218811266__p34380875">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_0218811266__p33387529">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811266__row20035339"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0218811266__p12249786">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_0218811266__p52708605">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0218811266__row4615402"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0218811266__p38303271">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_0218811266__p15557228">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>
View Git Blame Copy Permalink