yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a2e28c76231c99d8bbac87147becbb2b7e6be32e
doc-exports/docs/ccn/api-ref/ListGlobalConnectionBandwidthSites.html
fanqinying b662a89e70 CCN API 20250121 version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2026-01-29 15:36:46 +00:00

440 lines
37 KiB
HTML
Raw Blame History

<a name="ListGlobalConnectionBandwidthSites"></a><a name="ListGlobalConnectionBandwidthSites"></a>
<h1 class="topictitle1">Querying the Site List</h1>
<div id="body1708331107508"><div class="section" id="ListGlobalConnectionBandwidthSites__topic1921000000"><h4 class="sectiontitle">Function</h4><p id="ListGlobalConnectionBandwidthSites__topic1921000002">This API is used to query the site list.</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000003">Parameters <strong id="ListGlobalConnectionBandwidthSites__topic1921000004">marker</strong> and <strong id="ListGlobalConnectionBandwidthSites__topic1921000005">limit</strong> are used for pagination query. The two parameters take effect only when they are used together.</p>
</div>
<div class="section" id="ListGlobalConnectionBandwidthSites__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="ListGlobalConnectionBandwidthSites__topic1921000011">GET /v3/{domain_id}/gcb/sites</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGlobalConnectionBandwidthSites__topic1921000012" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListGlobalConnectionBandwidthSites__topic1921000020"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListGlobalConnectionBandwidthSites__topic1921000022">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListGlobalConnectionBandwidthSites__topic1921000024">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListGlobalConnectionBandwidthSites__topic1921000026">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListGlobalConnectionBandwidthSites__topic1921000028">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGlobalConnectionBandwidthSites__topic1921000030"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000032">domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000034">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000036">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListGlobalConnectionBandwidthSites__topic1921000038">Account ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGlobalConnectionBandwidthSites__topic1921000039" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListGlobalConnectionBandwidthSites__topic1921000047"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListGlobalConnectionBandwidthSites__topic1921000049">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListGlobalConnectionBandwidthSites__topic1921000051">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListGlobalConnectionBandwidthSites__topic1921000053">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListGlobalConnectionBandwidthSites__topic1921000055">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGlobalConnectionBandwidthSites__topic1921000057"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000059">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000061">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000063">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListGlobalConnectionBandwidthSites__topic1921000065">Number of records returned on each page.</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000066">The value ranges from 1 to 2000.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000067"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000069">marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000071">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000073">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListGlobalConnectionBandwidthSites__topic1921000075">Pagination query information. You can obtain the <strong id="ListGlobalConnectionBandwidthSites__topic1921000076">marker</strong> values from the response of the last API call. You can enter the <strong id="ListGlobalConnectionBandwidthSites__topic1921000077">marker</strong> value of the previous page or the next page. If you enter the <strong id="ListGlobalConnectionBandwidthSites__topic1921000078">marker</strong> value of the previous page, the previous page will be queried. If you enter the <strong id="ListGlobalConnectionBandwidthSites__topic1921000079">marker</strong> value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the <strong id="ListGlobalConnectionBandwidthSites__topic1921000080">limit</strong> value, cannot be modified.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000081"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000083">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000085">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000087">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListGlobalConnectionBandwidthSites__topic1921000089">Resource ID. Multiple IDs can be queried.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000090"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000092">name_en</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000094">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000096">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListGlobalConnectionBandwidthSites__topic1921000098">User-defined site information in English.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000099"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000101">name_cn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000103">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000105">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListGlobalConnectionBandwidthSites__topic1921000107">User-defined site information in English.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000108"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000110">site_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000112">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListGlobalConnectionBandwidthSites__topic1921000116">Site code.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000119">site_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000121">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000123">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListGlobalConnectionBandwidthSites__topic1921000125">Site type.</p>
<ul id="ListGlobalConnectionBandwidthSites__topic1921000126"><li id="ListGlobalConnectionBandwidthSites__topic1921000127"><p id="ListGlobalConnectionBandwidthSites__topic1921000128"><a name="ListGlobalConnectionBandwidthSites__topic1921000127"></a><a name="topic1921000127"></a><strong id="ListGlobalConnectionBandwidthSites__topic1921000129">Area</strong>: a geographic region site</p>
</li><li id="ListGlobalConnectionBandwidthSites__topic1921000130"><p id="ListGlobalConnectionBandwidthSites__topic1921000131"><a name="ListGlobalConnectionBandwidthSites__topic1921000130"></a><a name="topic1921000130"></a><strong id="ListGlobalConnectionBandwidthSites__topic1921000132">SubArea</strong>: a region site</p>
</li><li id="ListGlobalConnectionBandwidthSites__topic1921000133"><p id="ListGlobalConnectionBandwidthSites__topic1921000134"><a name="ListGlobalConnectionBandwidthSites__topic1921000133"></a><a name="topic1921000133"></a><strong id="ListGlobalConnectionBandwidthSites__topic1921000135">Region</strong>: a multi-city site</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListGlobalConnectionBandwidthSites__topic1921000136"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGlobalConnectionBandwidthSites__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListGlobalConnectionBandwidthSites__topic1921000145"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListGlobalConnectionBandwidthSites__topic1921000147">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListGlobalConnectionBandwidthSites__topic1921000149">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListGlobalConnectionBandwidthSites__topic1921000151">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListGlobalConnectionBandwidthSites__topic1921000153">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGlobalConnectionBandwidthSites__topic1921000155"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000157">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000159">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000161">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListGlobalConnectionBandwidthSites__topic1921000163">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListGlobalConnectionBandwidthSites__topic1921000164"><h4 class="sectiontitle">Response Parameters</h4><p id="ListGlobalConnectionBandwidthSites__topic1921000166"><strong id="ListGlobalConnectionBandwidthSites__topic1921000167">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGlobalConnectionBandwidthSites__response_ListGlobalConnectionBandwidthSitesResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListGlobalConnectionBandwidthSites__topic1921000174"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListGlobalConnectionBandwidthSites__topic1921000176">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListGlobalConnectionBandwidthSites__topic1921000178">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListGlobalConnectionBandwidthSites__topic1921000180">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGlobalConnectionBandwidthSites__topic1921000182"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000184">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000186">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000188">Request ID.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000189"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000191">page_info</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000193"><a href="#ListGlobalConnectionBandwidthSites__response_PageInfo">PageInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000196">Pagination query information.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000197"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000199">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000201">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000203">Total number of records.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000204"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000206">site_infos</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000208">Array of <a href="#ListGlobalConnectionBandwidthSites__response_GlobalConnectionBandwidthSites">GlobalConnectionBandwidthSites</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000211">Response body for querying the site list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListGlobalConnectionBandwidthSites__response_PageInfo"></a><a name="response_PageInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListGlobalConnectionBandwidthSites__response_PageInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>PageInfo</caption><thead align="left"><tr id="ListGlobalConnectionBandwidthSites__topic1921000218"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListGlobalConnectionBandwidthSites__topic1921000220">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListGlobalConnectionBandwidthSites__topic1921000222">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListGlobalConnectionBandwidthSites__topic1921000224">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGlobalConnectionBandwidthSites__topic1921000226"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000228">next_marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000230">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000232">Backward pagination identifier.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000233"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000235">previous_marker</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000237">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000239">Forward pagination identifier.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000240"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000242">current_count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000244">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000246">Number of the resources in the current list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListGlobalConnectionBandwidthSites__response_GlobalConnectionBandwidthSites"></a><a name="response_GlobalConnectionBandwidthSites"></a><table cellpadding="4" cellspacing="0" summary="" id="ListGlobalConnectionBandwidthSites__response_GlobalConnectionBandwidthSites" frame="border" border="1" rules="all"><caption><b>Table 6 </b>GlobalConnectionBandwidthSites</caption><thead align="left"><tr id="ListGlobalConnectionBandwidthSites__topic1921000253"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ListGlobalConnectionBandwidthSites__topic1921000255">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ListGlobalConnectionBandwidthSites__topic1921000257">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ListGlobalConnectionBandwidthSites__topic1921000259">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGlobalConnectionBandwidthSites__topic1921000261"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000263">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000265">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000267">Instance ID.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000268"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000270">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000272">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000274">Resource description. Angle brackets (&lt;&gt;) are not allowed.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000275"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000277">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000279">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000281">Time when the resource was created. The UTC time is in the <em id="ListGlobalConnectionBandwidthSites__topic1921000282">yyyy-MM-ddTHH:mm:ss</em> format.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000283"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000285">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000287">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000289">Time when the resource was updated. The UTC time must be in the <em id="ListGlobalConnectionBandwidthSites__topic1921000290">yyyy-MM-ddTHH:mm:ss</em> format.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000291"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000293">region_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000295">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000297">Region ID.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000298"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000300">name_en</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000302">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000304">User-defined site name in English.</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000305">Value range: 1 to 255 characters</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000306"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000308">name_cn</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000310">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000312">User-defined site name in English.</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000313">Value range: 1 to 64 characters</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000314"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000316">site_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000318">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000320">Site code in the format of &lt;area_code&gt;[-&lt;subarea_code&gt;[-&lt;region_code&gt;]].</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000321">Value range: 1 to 64 characters</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000322"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000324">site_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000326">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000328">Site type that corresponds to the site code. One code indicates a site in a geographic region, two codes indicate a site in a region, and three codes indicate a multi-city site.</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000329">The value can be:</p>
<ul id="ListGlobalConnectionBandwidthSites__topic1921000330"><li id="ListGlobalConnectionBandwidthSites__topic1921000331"><p id="ListGlobalConnectionBandwidthSites__topic1921000332"><a name="ListGlobalConnectionBandwidthSites__topic1921000331"></a><a name="topic1921000331"></a><strong id="ListGlobalConnectionBandwidthSites__topic1921000333">Area</strong>: a geographic region site</p>
</li><li id="ListGlobalConnectionBandwidthSites__topic1921000334"><p id="ListGlobalConnectionBandwidthSites__topic1921000335"><a name="ListGlobalConnectionBandwidthSites__topic1921000334"></a><a name="topic1921000334"></a><strong id="ListGlobalConnectionBandwidthSites__topic1921000336">SubArea</strong>: a region site</p>
</li><li id="ListGlobalConnectionBandwidthSites__topic1921000337"><p id="ListGlobalConnectionBandwidthSites__topic1921000338"><a name="ListGlobalConnectionBandwidthSites__topic1921000337"></a><a name="topic1921000337"></a><strong id="ListGlobalConnectionBandwidthSites__topic1921000339">Region</strong>: a multi-city site</p>
</li></ul>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000340"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000342">service_list</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000344">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000346">List of services supported at the site. Multiple services are separated by commas (,).</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000347">Value range: 0 to 255 characters</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000348"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000350">group_list</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000352">Array of <a href="#ListGlobalConnectionBandwidthSites__response_SiteGroupReferenceInfo">SiteGroupReferenceInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000355">Data model for association between site groups and external systems.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000358">public_border_group</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000360">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000362">Whether the site is a central site or an edge site. <strong id="ListGlobalConnectionBandwidthSites__topic1921000363">center</strong>: indicates a central site.</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000364">Value range: 0 to 255 characters</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000365"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000367">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000369">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000371">The specification code of the site.</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000372">This parameter has been discarded. Please do not use it.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000373"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000375">region_size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000377">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000379">The number of subordinates of the site.</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000380">This parameter has been discarded. Please do not use it.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000381"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000383">enable_share</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000385">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000387">Whether a global connection bandwidth can be used by multiple instances in the site.</p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000388">This parameter has been discarded. Please do not use it.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListGlobalConnectionBandwidthSites__response_SiteGroupReferenceInfo"></a><a name="response_SiteGroupReferenceInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListGlobalConnectionBandwidthSites__response_SiteGroupReferenceInfo" frame="border" border="1" rules="all"><caption><b>Table 7 </b>SiteGroupReferenceInfo</caption><thead align="left"><tr id="ListGlobalConnectionBandwidthSites__topic1921000395"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ListGlobalConnectionBandwidthSites__topic1921000397">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ListGlobalConnectionBandwidthSites__topic1921000399">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ListGlobalConnectionBandwidthSites__topic1921000401">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGlobalConnectionBandwidthSites__topic1921000403"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000405">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000407">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000409">Instance ID.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000410"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000412">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000414">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000416">Resource description. Angle brackets (&lt;&gt;) are not allowed.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000417"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000419">name_en</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000421">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000423">User-defined site group name in English.</p>
</td>
</tr>
<tr id="ListGlobalConnectionBandwidthSites__topic1921000424"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000426">name_cn</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000428">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListGlobalConnectionBandwidthSites__topic1921000430">User-defined site group name in English.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListGlobalConnectionBandwidthSites__topic1921000431"><h4 class="sectiontitle">Example Requests</h4><p id="ListGlobalConnectionBandwidthSites__topic1921000433">Querying the site list</p>
<pre class="screen" id="ListGlobalConnectionBandwidthSites__topic1921000434">GET https://{cc_endpoint}/v3/{domain_id}/gcb/sites</pre>
</div>
<div class="section" id="ListGlobalConnectionBandwidthSites__topic1921000435"><h4 class="sectiontitle">Example Responses</h4><p id="ListGlobalConnectionBandwidthSites__topic1921000437"><strong id="ListGlobalConnectionBandwidthSites__topic1921000438">Status code: 200</strong></p>
<p id="ListGlobalConnectionBandwidthSites__topic1921000439">The site list has been queried.</p>
<pre class="screen" id="ListGlobalConnectionBandwidthSites__topic1921000440">{
"request_id" : "61126320a1802d5c6444f9d2d76526c2",
"site_infos" : [ {
"id" : "5c2d5343-cde2-4a41-83ae-56b7f44d73b5",
"description" : "description",
"name_cn" : "Site abc",
"name_en" : "site-abc",
"site_code" : "site-abc",
"site_type" : "Region",
"service_list" : "CC,GCN",
"region_id" : "region-abc",
"public_border_group" : "center",
"group_list" : [ {
"id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
"description" : "description"
} ],
"created_at" : "2024-01-24T08:26:41.914Z",
"updated_at" : "2024-01-24T08:26:41.914Z"
} ],
"total_count" : 10,
"page_info" : {
"next_marker" : "XXX",
"previous_marker" : "XXX",
"current_count" : 1
}
}</pre>
</div>
<div class="section" id="ListGlobalConnectionBandwidthSites__topic1921000441"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListGlobalConnectionBandwidthSites__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListGlobalConnectionBandwidthSites__topic1921000447"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListGlobalConnectionBandwidthSites__topic1921000449">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListGlobalConnectionBandwidthSites__topic1921000451">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListGlobalConnectionBandwidthSites__topic1921000453"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListGlobalConnectionBandwidthSites__topic1921000455">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListGlobalConnectionBandwidthSites__topic1921000457">The site list has been queried.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListGlobalConnectionBandwidthSites__topic1921000458"><h4 class="sectiontitle">Error Codes</h4><p id="ListGlobalConnectionBandwidthSites__topic1921000460">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_300000019.html">Global Connection Bandwidths</a></div>
</div>
</div>
View Git Blame Copy Permalink