Help Center/ Ubiquitous Cloud Native Service/ API Reference/ API/ UCS Cluster/ Querying Cluster Access Information
Updated on 2024-04-30 GMT+08:00

Querying Cluster Access Information

Function

This API is used to query 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 query 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 Parameters

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 for accessing on-premises clusters. This parameter is mandatory for clusters on the private network.

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

region

No

String

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

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Identity authentication information

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

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.