Resetting a Node¶
Function¶
This API is used to reset a node in a specified cluster.
Note
The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.
URI¶
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/reset
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
cluster_id | Yes | String | Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
Content-Type | Yes | String | Message body type (format). |
X-Auth-Token | Yes | String | 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, see API Usage Guidelines. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
apiVersion | Yes | String | API version. The value is fixed at v3. |
kind | Yes | String | API type. The value is fixed at List. |
nodeList | Yes | Array of ResetNode objects | List of the nodes to be reset. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
nodeID | Yes | String | Node ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. |
spec | Yes | ReinstallNodeSpec object | Node reinstallation configuration parameters. Nodes in a node pool cannot be specified externally. These nodes will be reinstalled based on the node pool settings. By default, this parameter is mandatory for nodes in a node pool. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
os | Yes | String | Operating system. If you specify a custom image, the actual OS version in the IMS image is used. Select an OS version supported by the current cluster, for example, EulerOS 2.5, EulerOS 2.9, Ubuntu 22.04, or HCE OS 2.0. |
login | Yes | Login object | Node login mode. |
name | No | String | Node name. Note Specifying this field during reinstallation will change the node name, and the server name will change accordingly. By default, the current server name is used as the node name. Enter 1 to 56 characters starting with a letter and not ending with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed. |
serverConfig | No | ReinstallServerConfig object | Server configuration. |
volumeConfig | No | ReinstallVolumeConfig object | Volume management configuration. |
runtimeConfig | No | ReinstallRuntimeConfig object | Container runtime configuration. |
k8sOptions | No | ReinstallK8sOptionsConfig object | Kubernetes node configuration. |
lifecycle | No | NodeLifecycleConfig object | Customized lifecycle configuration of a node. |
initializedConditions | No | Array of strings | Custom initialization flag. Before CCE nodes are initialized, they are tainted with node.cloudprovider.kubernetes.io/uninitialized to prevent pods from being scheduled to them. CCE supports custom initialization flags. After receiving the initializedConditions parameter, CCE converts the parameter value into a node label and provisions the label with the node, for example, cloudprovider.openvessel.io/inject-initialized-conditions=CCEInitial_CustomedInitial. After the node is labeled, its status.Conditions is polled to check whether the type of conditions has a flag name, such as CCEInitial and CustomedInitial. If all input flags exist and their status is True, the node initialization is complete and the initialization taint is removed.
|
extendParam | No | ReinstallExtendParam object | Extended reinstallation parameter, which is discarded. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
sshKey | No | String | Name of the key pair used for login. |
userPassword | No | String | Password used for node login. Note This field is not supported for the current version. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
userTags | No | Array of UserTag objects | Cloud server labels. The key of a label must be unique. The maximum number of user-defined labels supported by CCE depends on the region. In the region that supports the least number of labels, you can still create up to 5 labels for a cloud server. |
rootVolume | No | ReinstallVolumeSpec object | System disk configurations used in reinstallation. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
key | No | String | Key of the cloud server label. The value cannot start with CCE- or __type_baremetal. |
value | No | String | Value of the cloud server label. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
imageID | No | String | Custom image ID. |
cmkID | No | String | User master key ID. If this parameter is left blank by default, the EVS disk is not encrypted. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
lvmConfig | No | String | Docker data disk configurations. The following is an example default configuration: "lvmConfig":"dockerThinpool=vgpaas/90%VG;kubernetesLV=vgpaas/10%VG;diskType=evs;lvType=linear"
The following fields are included:
|
storage | No | Storage object | Disk initialization management parameter. This parameter is complex to configure. For details, see Attaching Disks to a Node. If this parameter retains its default, disks are managed based on the DockerLVMConfigOverride (discarded) parameter in extendParam. This parameter is supported by clusters of version 1.15.11 and later. Note If a node specification involves local disks and EVS disks at the same time, do not retain the default value of this parameter to prevent unexpected disk partitions. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
storageSelectors | Yes | Array of StorageSelectors objects | Disk selection. Matched disks are managed according to matchLabels and storageType. |
storageGroups | Yes | Array of StorageGroups objects | A storage group consists of multiple storage devices. It is used to divide storage space. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
name | Yes | String | Selector name, used as the index of selectorNames in storageGroup. Therefore, the name of each selector must be unique. |
storageType | Yes | String | Specifies the storage type. Currently, only evs (EVS volumes) and local (local volumes) are supported. The local storage does not support disk selection. All local disks will form a VG. Therefore, only one storageSelector of the local type is allowed. |
matchLabels | No | matchLabels object | Matching field of an EVS volume. The size, volumeType, metadataEncrypted, metadataCmkid and count fields are supported. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
size | No | String | Matched disk size. If this parameter is left unspecified, the disk size is not limited. Example: 100 |
volumeType | No | String | EVS disk type.
|
metadataEncrypted | No | String | Disk encryption identifier. 0 indicates that the disk is not encrypted, and 1 indicates that the disk is encrypted. |
metadataCmkid | No | String | Customer master key ID of an encrypted disk. The value is a 36-byte string. |
count | No | String | Number of disks to be selected. If this parameter is left blank, all disks of this type are selected. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
name | Yes | String | Name of a virtual storage group, which must be unique. |
cceManaged | No | Boolean | Storage space for Kubernetes and runtime components. Only one group can be set to true. If this parameter is left blank, the default value false is used. |
selectorNames | Yes | Array of strings | This parameter corresponds to name in storageSelectors. A group can match multiple selectors, but a selector can match only one group. |
virtualSpaces | Yes | Array of VirtualSpace objects | Detailed management of space configuration in a group. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
name | Yes | String | Name of a virtualSpace.
|
size | Yes | String | Size of a virtualSpace. The value must be an integer in percentage. Example: 90%. Note The sum of the percentages of all virtualSpaces in a group cannot exceed 100%. |
lvmConfig | No | LVMConfig object | LVM configurations, applicable to kubernetes and user spaces. Note that one virtual space supports only one config. |
runtimeConfig | No | RuntimeConfig object | runtime configurations, applicable to the runtime space. Note that one virtual space supports only one config. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
lvType | Yes | String | LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance. |
path | No | String | Path to which the disk is attached. This parameter takes effect only in user configuration. The value is an absolute path. Digits, letters, periods (.), hyphens (-), and underscores (_) are allowed. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
lvType | Yes | String | LVM write mode. linear indicates the linear mode. striped indicates the striped mode, in which multiple disks are used to form a strip to improve disk performance. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
dockerBaseSize | No | Integer | Available disk space of a single container on a node, in GB. If this parameter is left blank or is set to 0, the default value is used. In Device Mapper mode, the default value is 10. In OverlayFS mode, the available space of a single container is not limited by default, and the dockerBaseSize setting takes effect only on EulerOS nodes in the cluster of the new version. When Device Mapper is used, you are advised to set dockerBaseSize to a value less than or equal to 80 GB. If the value is too large, the container runtime may fail to be started due to long initialization. If there are special requirements for the container disk space, you can mount an external or local storage device. |
runtime | No | Runtime object | Container runtime. Defaults to docker. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
name | No | String | Container runtime. Defaults to docker. Enumeration values:
|
Parameter | Mandatory | Type | Description |
---|---|---|---|
labels | No | Map<String,String> | Defined in key-value pairs. A maximum of 20 key-value pairs are allowed.
Example: "k8sTags": {
"key": "value"
}
|
taints | No | Array of Taint objects | Taints can be added for anti-affinity when creating nodes. A maximum of 20 taints can be added. Each taint contains the following parameters:
Example: "taints": [{
"key": "status",
"value": "unavailable",
"effect": "NoSchedule"
}, {
"key": "looks",
"value": "bad",
"effect": "NoSchedule"
}]
|
maxPods | No | Integer | Maximum number of pods that can be created on a node, including the default system pods. Value range: 16 to 256. This limit prevents the node from being overloaded of pods. |
nicMultiqueue | No | String |
"[{\"queue\":4}]"
The following fields are included:
|
nicThreshold | No | String |
"0.3:0.6"
|
Parameter | Mandatory | Type | Description |
---|---|---|---|
key | Yes | String | Key. |
value | No | String | Value. |
effect | Yes | String | Effect. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
preInstall | No | String | Pre-installation script. Note The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64) |
postInstall | No | String | Post-installation script. Note The input value must be Base64-encoded. (Command: echo -n "Content to be encoded" | base64) |
Parameter | Mandatory | Type | Description |
---|---|---|---|
alpha.cce/NodeImageID | No | String | (Discarded) ID of the user image to run the target OS. Specifying this parameter is equivalent to specifying imageID in ReinstallVolumeSpec. The original value will be overwritten. |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
jobid | String | Job ID returned after the job is delivered. The job ID can be used to query the job execution status. |
Example Requests¶
Resetting nodes in the default node pool
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/reset { "kind" : "List", "apiVersion" : "v3", "nodeList" : [ { "nodeID" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy", "spec" : { "name" : "my-ecs-0001", "os" : "EulerOS 2.5", "login" : { "sshKey" : "KeyPair-001" } } } ] }
Reset a node in a node pool (invalid spec).
POST /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/reset { "kind" : "List", "apiVersion" : "v3", "nodeList" : [ { "nodeID" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "spec" : { "name" : "my-ecs-0001", "os" : "EulerOS 2.5", "login" : { "sshKey" : "KeyPair-001" } } } ] }
Example Responses¶
Status code: 200
The job for resetting a node in a specified cluster is successfully delivered.
{
"jobid" : "2ec9b78d-9368-46f3-8f29-d1a95622a568"
}
Status Codes¶
Status Code | Description |
---|---|
200 | The job for resetting a node in a specified cluster is successfully delivered. |
Error Codes¶
See Error Codes.