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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
clusterid |
Yes |
String |
Cluster ID |
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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Identity authentication information |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[Array] |
Array of strings |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
- |
String |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
- |
String |
Status code: 500
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot