Obtaining the Control Plane Node List (To Be Discarded)
Function
This API is used to obtain the control plane nodes of a cluster.
Calling Method
For details, see Calling APIs.
URI
GET /api/v2/projects/{project_id}/clusters/{cluster_id}/masters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID. For details about how to obtain the project ID, see How to Obtain Parameters in the API URI. Constraints N/A Range The project ID of the account Default Value N/A |
|
cluster_id |
Yes |
String |
Definition Cluster ID. For details about how to obtain the cluster ID, see How to Obtain Parameters in the API URI. Constraints N/A Range Cluster ID Default Value N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
Content-Type |
Yes |
String |
Definition The request body type or format Constraints GET requests are not validated. Range Default Value N/A |
|
X-Auth-Token |
Yes |
String |
Definition 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. For details about how to obtain a token, see Authentication. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
kind |
String |
Definition API type Constraints N/A Range N/A Default Value List |
|
apiVersion |
String |
Definition API version Constraints N/A Range N/A Default Value v2 |
|
items |
Array of MasterNode objects |
Definition Control plane node information list Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
kind |
String |
Definition API type Constraints N/A Range N/A Default Value Host |
|
apiVersion |
String |
Definition API version Constraints N/A Range N/A Default Value v2 |
|
metadata |
MasterNodeMetadata object |
Definition Control plane node metadata Constraints N/A Range N/A Default Value N/A |
|
spec |
MasterNodeSpec object |
Definition Control plane node details Constraints N/A Range N/A Default Value N/A |
|
status |
MasterNodeStatus object |
Definition Control plane node status Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
uid |
String |
Definition Control plane node ID Constraints N/A Range N/A Default Value N/A |
|
name |
String |
Definition Control plane node name Constraints N/A Range N/A Default Value N/A |
|
creationTimestamp |
String |
Definition Time when the control plane node was created Constraints N/A Range N/A Default Value N/A |
|
updateTimestamp |
String |
Definition Last update time of a control plane node Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
az |
String |
Definition AZ where the control plane node is located Constraints N/A Range N/A Default Value N/A |
|
privateIp |
String |
Definition Private IP address of the control plane node Constraints N/A Range N/A Default Value N/A |
|
flavor |
String |
Definition Type of the ECS serving as a control plane node Constraints N/A Range N/A Default Value N/A |
|
cpu |
Integer |
Definition Number of CPU cores on a control plane node Constraints N/A Range N/A Default Value N/A |
|
memory |
Integer |
Definition Memory size of a control plane node Constraints N/A Range N/A Default Value N/A |
|
serverId |
String |
Definition ID of the ECS serving as a control plane node Constraints N/A Range N/A Default Value N/A |
|
extendParam |
Map<String,String> |
Definition Additional parameters of a control plane node Constraints N/A Range N/A Default Value N/A |
Example Requests
N/A
Example Responses
Status code: 200
The node information in the VPC has been obtained.
{
"kind" : "List",
"apiVersion" : "v2",
"items" : [ {
"kind" : "Host",
"apiVersion" : "v2",
"metadata" : {
"name" : "nvdkl-master-1",
"uid" : "a6321127-95c4-11f0-addc-0255ac1001b6",
"creationTimestamp" : "2025-09-20 01:53:48.291391 +0000 UTC",
"updateTimestamp" : "2025-09-20 02:00:59.92607 +0000 UTC"
},
"spec" : {
"az" : "cn-north-7c",
"privateIp" : "192.168.0.169",
"flavor" : "st6.xlarge.2",
"cpu" : 4,
"memory" : 8,
"serverId" : "d59880cc-f757-487b-853f-a29134bdcc14",
"extendParam" : {
"portId" : "5763bb17-8d59-47df-8cbc-6ab91ad3eab4"
}
},
"status" : {
"status" : "Active"
}
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The node information in the VPC has been obtained. |
Error Codes
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