Files

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

11 KiB

Raw Blame History

Obtaining Cluster Access Information

Function

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.

URI

GET /v1/clusters/{clusterid}/accessinfo

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
clusterid	Yes	String	Cluster ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
vpcendpoint	No	String	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.
region	No	String	Access region. This parameter is mandatory for clusters accessed over the private network.

Request Parameters

**Table 3** Parameter in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	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.

Response Parameters

Status code: 200

**Table 4** Parameter in the response body
Parameter	Type	Description
[Array]	Array of strings	The cluster access information is returned. If the API has been called, the message "Downloaded" is returned.

Example Requests

None

Example Responses

None

Status Codes

Status Code	Description
200	The cluster access information is returned. If the API has been called, the message "Downloaded" is returned.
400	Client request error. The server could not execute the request.
403	The server refused the request.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic: UCS Clusters

11 KiB Raw Blame History