Obtaining Node Resource Details (To Be Discarded)

Function

This API is used to obtain the node resource details.

Calling Method

For details, see Calling APIs.

URI

GET /cce/v1/projects/{project_id}/clusters/{cluster_id}/noderesources

**Table 1** URI parameters
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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition The request body type or format Constraints GET requests are not validated. Range application/json application/json;charset=utf-8 application/x-pem-file multipart/form-data (used when the FormData parameter is present) 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

**Table 3** Response body parameters
Parameter	Type	Description
cluster_id	String	Definition Cluster ID Constraints N/A Range N/A Default Value N/A
node_num	Integer	Definition The number of nodes in a cluster Constraints N/A Range N/A Default Value N/A
nodes	Array of NodeResourceDetail objects	Definition Node resource details list Constraints N/A Range N/A Default Value N/A

**Table 4** NodeResourceDetail
Parameter	Type	Description
node_id	String	Definition Node ID Constraints N/A Range N/A Default Value N/A
server_id	String	Definition ID of an ECS serving as a node Constraints N/A Range N/A Default Value N/A
private_ip	String	Definition Private IPv4 address of a node Constraints N/A Range N/A Default Value N/A
host_name	String	Definition Node name Constraints N/A Range N/A Default Value N/A
flavor	flavor object	Definition Flavor of the ECS serving as a node Constraints N/A Range N/A Default Value N/A
status	String	Definition Node status, which is the status of a node during its lifecycle (such as installation and uninstallation) and the status of a node in a Kubernetes cluster Constraints N/A Range Node resource lifecycle management (such as installation and uninstallation) status and Kubernetes node status in a cluster. The options include: Build: The node is being created. Installing: The node is being managed. Upgrading: The node is being upgraded. Active: The node is running properly. Abnormal: The node is abnormal. Deleting: The node is being deleted. Error: The node is faulty. Default Value N/A
vm_status	String	Definition Status of the ECS serving as a node Constraints N/A Range N/A Default Value N/A
charging_mode	String	Definition Billing mode of a node Constraints N/A Range 0: The node is billed on a pay-per-use basis. 1: The node is billed on a yearly/monthly basis. Default Value N/A
enterprise_project_id	String	Definition Enterprise project ID of a node Constraints N/A Range N/A Default Value N/A
is_locked	Boolean	Definition Whether there is already an order for a node Constraints N/A Range N/A Default Value N/A
az	String	Definition AZ that a node belongs to Constraints N/A Range N/A Default Value N/A
cloudServiceType	String	Definition Code of the cloud service that the ECS serving as a node belongs to Constraints N/A Range N/A Default Value N/A
resourceType	String	Definition Resource type code of the cloud service that the ECS serving as a node belongs to Constraints N/A Range N/A Default Value N/A
resourceSpecCode	String	Definition Code of the cloud service flavor that the ECS serving as a node belongs to Constraints N/A Range N/A Default Value N/A
lockScene	String	Definition Scenarios where the ECS serving as a node is locked Constraints N/A Range N/A Default Value N/A
lockSource	String	Definition Cloud service name of the locked ECS serving as a node Constraints N/A Range N/A Default Value N/A
lockSourceId	String	Definition Cloud service resource ID of the locked ECS serving as a node Constraints N/A Range N/A Default Value N/A

**Table 5** flavor
Parameter	Type	Description
vcpus	String	Definition Number of CPU cores on the ECS serving as a node Constraints N/A Range N/A Default Value N/A
ram	String	Definition Memory size of the ECS serving as a node, unit: M Constraints N/A Range N/A Default Value N/A
id	String	Definition Flavor ID of the ECS serving as a node Constraints N/A Range N/A Default Value N/A
name	String	Definition Flavor name of the ECS serving as a node Constraints N/A Range N/A Default Value N/A

Example Requests

N/A

Example Responses

Status code: 200

The node resource details have been obtained.

{
  "cluster_id" : "9461db5e-95c4-11f0-addc-0255ac1001b6",
  "node_num" : 1,
  "nodes" : [ {
    "node_id" : "66642cf0-95d0-11f0-a134-0255ac100b02",
    "server_id" : "e86adc18-a6fd-44c6-8cd6-7b4ceb13d927",
    "private_ip" : "192.168.0.41",
    "host_name" : "node-0kjyyl",
    "flavor" : {
      "vcpus" : "2",
      "ram" : "4096",
      "id" : "c6.large.2",
      "name" : "c6.large.2"
    },
    "status" : "Active",
    "vm_status" : "ACTIVE",
    "charging_mode" : "0",
    "enterprise_project_id" : "0",
    "is_locked" : false,
    "az" : "cn-north-7c",
    "cloudServiceType" : "hws.service.type.ec2",
    "resourceType" : "hws.resource.type.vm",
    "resourceSpecCode" : "c6.large.2.linux",
    "lockScene" : "OTHER_SVC_LOCK=toperiod",
    "lockSource" : "CCE",
    "lockSourceId" : "9461db5e-95c4-11f0-addc-0255ac1001b6"
  } ]
}