Help Center/ Ubiquitous Cloud Native Service/ API Reference/ API/ UCS Clusters/ Obtaining Cluster Access Information
Updated on 2025-07-29 GMT+08:00

Obtaining Cluster Access Information

Function

This API is used to obtain cluster access information. The input cluster ID must comply with the Kubernetes UUID format. In addition, you must have permission to obtain the cluster certificate. 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 cloud network must be connected.

For details about how to create a VPC endpoint and query its IP address, see Creating a VPC Endpoint.

region

No

String

Access region. This parameter is mandatory for clusters accessed over the private network.

Request Parameters

Table 3 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Identity authentication information

Response Parameters

Status code: 200

Table 4 Parameter in the response body

Parameter

Type

Description

[Array]

Array of strings

  

Status code: 400

Table 5 Parameter in the response body

Parameter

Type

Description

-

String

  

Status code: 403

Table 6 Parameter in the response body

Parameter

Type

Description

-

String

  

Status code: 500

Table 7 Parameter in the response body

Parameter

Type

Description

-

String

  

Example Request

None

Example Response

None

Status Codes

Status Code

Description

200

The cluster access information was returned. If the API has been called, the message "Downloaded" was returned.

400

Client request error. The server could not execute the request.

403

The server refused the request.

500

Internal server error.

Error Codes

For details, see Error Codes.