Get UK8S Node Details - DescribeUK8SNode

Overview

Used to get UK8S node details

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUK8SNode`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
ClusterId	string	UK8S Cluster Id	Yes
Name	string	K8S Node IP or Node ID	Yes

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
Name	string	Node Name	Yes
Labels	array[string]	An array of strings, each item is a label similar to "kubernetes.io/arch=amd64"."""	Yes
Annotations	array[string]	An array of strings, each item is an annotation similar to "node.alpha.kubernetes.io/ttl=0".	Yes
CreationTimestamp	int	Timestamp, unit is seconds	Yes
ProviderID	string	String, such as: "SurferCloud://cn-sh2-02//uk8s-vsc0vgob-n-mpzxc"	Yes
KernelVersion	string	Kernel version, such as: '4.19.0-6.el7.ucloud.x86_64'	Yes
OSImage	string	Operating system type, such as: "CentOS Linux 7 (Core)	Yes
ContainerRuntimeVersion	string	Version of container runtime, such as: "docker://18.9.9 ".	Yes
KubeletVersion	string	kubelet version	Yes
KubeProxyVersion	string	kubeproxy version	Yes
InternalIP	string	Internal IP Address	Yes
Hostname	string	Hostname	Yes
AllocatedPodCount	int	Number of Pods assigned to the current node	Yes
PodCapacity	int	The maximum number of Pods that can be allocated to a node	Yes
Unschedulable	boolean	Is scheduling prohibited?	Yes
CPUCapacity	string	Total Node CPU	Yes
MemoryCapacity	string	Total Node Memory	Yes
MemoryRequests	string	Memory request amount of Pods allocated on the node	Yes
MemoryRequestsFraction	string	The proportion of memory requests allocated to Pods on the node to the total memory, if the return value is '4.5', it means that the request amount accounts for 4.5% of the total.	Yes
MemoryLimits	string	Memory limit of Pods allocated on the node	Yes
MemoryLimitsFraction	string	The proportion of the memory limit allocated to the Pod on the node to the total memory. If the return value is '18', it means that the limit accounts for 18% of the total.	Yes
CPURequests	string	CPU request amount of Pods allocated on the node	Yes
CPURequestsFraction	string	The proportion of CPU requests from Pods allocated on the node to the total CPU amount	Yes
CPULimits	string	CPU limit value of the Pod allocated on the node	Yes
CPULimitsFraction	string	The proportion of the CPU limit value of the Pod allocated on the node to the total CPU	Yes
Conditions	array[K8SNodeCondition]	Node Status Array	Yes
ContainerImages	array[string]	Array of image names on the node	Yes
Taints	array[string]	An array of strings, each item is a taint similar to "node-role.kubernetes.io/master:NoSchedule"."""	No

Data Model

K8SNodeCondition

Field Name	Type	Description Information	Required
Type	string	Condition types, such as MemoryPressure, DiskPressure, PIDPressure, Ready	No
Status	string	Status, False, True	No
LastProbeTime	string	Time of the last reported status	No
LastTransitionTime	string	Last Status Change Time	No
Reason	string	Reason for status change	No
Message	string	Description of status changes	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeUK8SNode
&Region=cn-zj
&ProjectId=sElnRLjI
&ClusterId=totqQYHI
&Name=ErXQmXnS

Response Example

{
  "Action": "DescribeUK8SNodeResponse",
  "AllocatedPodCount": 6,
  "Annotations": [
    "tUWHbrau"
  ],
  "CPUCapacity": "tBszdZRU",
  "CPULimits": "nGbRDmDr",
  "CPULimitsFraction": "LbRKZfsS",
  "CPURequests": "cvVLzNiY",
  "CPURequestsFraction": "wlEcpxok",
  "Conditions": [
    {
      "LastProbeTime": "FWAXrjEN",
      "LastTransitionTime": "KLsUrcTC",
      "Message": "VxQgKfIh",
      "Reason": "UGvztFUN",
      "Status": "CtIFlmpX",
      "Type": "mHcsdTJk"
    }
  ],
  "ContainerImages": [
    "txoXMWDk"
  ],
  "ContainerRuntimeVersion": "zBeQNCmz",
  "CreationTimestamp": 9,
  "Hostname": "HBdXzYsk",
  "InternalIP": "pyyLHaZv",
  "KernelVersion": "gClfaDNr",
  "KubeProxyVersion": "LPRmIqRm",
  "KubeletVersion": "bWvoYPZk",
  "Labels": [
    "lJIBSxcK"
  ],
  "MemoryCapacity": "AObOjZst",
  "MemoryLimits": "TGUARMCd",
  "MemoryLimitsFraction": "LvrhQhjA",
  "MemoryRequests": "RslUIMdZ",
  "MemoryRequestsFraction": "WuedwXMx",
  "Message": "sNFzyWny",
  "Name": "OepprctA",
  "OSImage": "wQyBoQPR",
  "PodCapacity": 9,
  "ProviderID": "NfHgjXUd",
  "RetCode": 0,
  "Taints": [
    "RnidVmEy"
  ],
  "Unschedulable": false
}

DescribeUK8SImage ListUK8SClusterNodeV2