yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
535e30e2926538a0313315e24d776685e6d0f53e
doc-exports/docs/ucs/api-ref/ShowClusterAccessInfo.html
qiujiandong1 535e30e292 UCS API initial update 20250523 version 
Reviewed-by: Gergo-Bence Lorincz <a200452876@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2026-02-23 09:12:31 +00:00

152 lines
11 KiB
HTML
Raw Blame History

<a name="ShowClusterAccessInfo"></a><a name="ShowClusterAccessInfo"></a>
<h1 class="topictitle1">Obtaining Cluster Access Information</h1>
<div id="body1735481713354"><div class="section" id="ShowClusterAccessInfo__section8355121714351"><h4 class="sectiontitle">Function</h4><p id="ShowClusterAccessInfo__p183554172354">This API is used to obtain the cluster access information. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the permission to query the corresponding cluster. Otherwise, the authentication fails. The agent certificate can be downloaded only once. This API is only used to obtain the access information of third-party clusters. If a CCE cluster ID is transferred, 400 will be returned.</p>
</div>
<div class="section" id="ShowClusterAccessInfo__section1635515179358"><h4 class="sectiontitle">URI</h4><p id="ShowClusterAccessInfo__p113551717133516">GET /v1/clusters/{clusterid}/accessinfo</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterAccessInfo__table5356191783513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="ShowClusterAccessInfo__row535512170350"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowClusterAccessInfo__p7356317173515">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowClusterAccessInfo__p1635661714351">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowClusterAccessInfo__p1735611733512">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowClusterAccessInfo__p93561017153512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterAccessInfo__row73552017143510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowClusterAccessInfo__p133561174357">clusterid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowClusterAccessInfo__p1735720173355">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowClusterAccessInfo__p6357111723520">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowClusterAccessInfo__p235714173358">Cluster ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterAccessInfo__table11358161713350" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="ShowClusterAccessInfo__row435701710355"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ShowClusterAccessInfo__p133581117203511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ShowClusterAccessInfo__p12358417163513">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ShowClusterAccessInfo__p2358151793515">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ShowClusterAccessInfo__p13359417173515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterAccessInfo__row5357151711355"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowClusterAccessInfo__p1359151753520">vpcendpoint</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowClusterAccessInfo__p1435921723515">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowClusterAccessInfo__p15359101711350">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowClusterAccessInfo__p335901714355">IP address of the VPC endpoint. This parameter is mandatory for clusters accessed over the private network. The third-party network and the VPC network must be connected.</p>
</td>
</tr>
<tr id="ShowClusterAccessInfo__row735821717358"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ShowClusterAccessInfo__p2359141712350">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ShowClusterAccessInfo__p93601517113518">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ShowClusterAccessInfo__p1936016177354">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ShowClusterAccessInfo__p133601117163510">Access region. This parameter is mandatory for clusters accessed over the private network.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowClusterAccessInfo__section1436041733516"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterAccessInfo__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter in the request header</caption><thead align="left"><tr id="ShowClusterAccessInfo__row8360171713354"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowClusterAccessInfo__p1936111713350">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowClusterAccessInfo__p15361417153510">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowClusterAccessInfo__p436120179351">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowClusterAccessInfo__p836115178350">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterAccessInfo__row036181713355"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowClusterAccessInfo__p83626178351">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowClusterAccessInfo__p11362141723512">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowClusterAccessInfo__p183621317123518">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowClusterAccessInfo__p1266617331861">Identity authentication information. Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowClusterAccessInfo__section836313176355"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowClusterAccessInfo__p173631117193510"><strong id="ShowClusterAccessInfo__b9211152594153">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterAccessInfo__response_-" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter in the response body</caption><thead align="left"><tr id="ShowClusterAccessInfo__row4363151711356"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowClusterAccessInfo__p43631917133516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowClusterAccessInfo__p193641176358">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowClusterAccessInfo__p236419171354">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterAccessInfo__row6363121711356"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowClusterAccessInfo__p113646179355">[Array]</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowClusterAccessInfo__p236415175354">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowClusterAccessInfo__p1836417170355">The cluster access information is returned. If the API has been called, the message "Downloaded" is returned.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowClusterAccessInfo__section123641317113518"><h4 class="sectiontitle">Example Requests</h4><p id="ShowClusterAccessInfo__p1365181711358">None</p>
</div>
<div class="section" id="ShowClusterAccessInfo__section163654173353"><h4 class="sectiontitle">Example Responses</h4><p id="ShowClusterAccessInfo__p103651317133519">None</p>
</div>
<div class="section" id="ShowClusterAccessInfo__section1236511718353"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowClusterAccessInfo__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowClusterAccessInfo__row18365101793515"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowClusterAccessInfo__p18366191703519">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowClusterAccessInfo__p93661517173519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowClusterAccessInfo__row7365131714351"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowClusterAccessInfo__p17366817153518">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowClusterAccessInfo__p5366121783517">The cluster access information is returned. If the API has been called, the message "Downloaded" is returned.</p>
</td>
</tr>
<tr id="ShowClusterAccessInfo__row15365201783517"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowClusterAccessInfo__p0366617133511">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowClusterAccessInfo__p13366161710356">Client request error. The server could not execute the request.</p>
</td>
</tr>
<tr id="ShowClusterAccessInfo__row203651817173514"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowClusterAccessInfo__p1236641733511">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowClusterAccessInfo__p15366141793517">The server refused the request.</p>
</td>
</tr>
<tr id="ShowClusterAccessInfo__row236581743510"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowClusterAccessInfo__p936681720359">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowClusterAccessInfo__p83671917123518">Internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowClusterAccessInfo__section4367111711354"><h4 class="sectiontitle">Error Codes</h4><p id="ShowClusterAccessInfo__p036771711359">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">UCS Clusters</a></div>
</div>
</div>
View Git Blame Copy Permalink