更新时间:2024-10-10 GMT+08:00
分享

节点移除

功能介绍

该API用于在指定集群下移除节点。

集群管理的URL格式为:https://Endpoint/uri。其中uri为资源路径,也即API访问的路径。

调用方法

请参见如何调用API

URI

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/remove

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,获取方式请参见如何获取接口URI中参数

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID,获取方式请参见如何获取接口URI中参数

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)

约束限制:

GET方法不做校验

取值范围:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

默认取值:

不涉及

X-Auth-Token

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

apiVersion

String

API版本,固定值“v3”。

kind

String

API类型,固定值“RemoveNodesTask”。

spec

RemoveNodesSpec object

配置信息

status

TaskStatus object

任务状态

表4 RemoveNodesSpec

参数

是否必选

参数类型

描述

login

Login object

节点的登录方式。密钥对和密码登录方式二者必选其一。

说明:

更新节点池时,不支持修改此参数

nodes

Array of NodeItem objects

待操作节点列表,当前最多支持同时移除200个节点。

表5 Login

参数

是否必选

参数类型

描述

sshKey

String

参数解释

选择密钥对方式登录时的密钥对名称。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

userPassword

UserPassword object

参数解释

选择密码方式登录时的账号密码信息,之后可通过此账号密码登录节点。

约束限制

不涉及

表6 UserPassword

参数

是否必选

参数类型

描述

username

String

参数解释

登录账号,默认为“root”。

约束限制

不涉及

取值范围

不涉及

默认取值

root。

password

String

参数解释

登录密码,若创建节点通过用户名密码方式,即使用该字段,则响应体中该字段作屏蔽展示。

约束限制

创建节点时password字段需要加盐加密,具体方法请参见创建节点时password字段加盐加密

取值范围

密码复杂度要求:

  • 长度为8-26位。

  • 密码至少必须包含大写字母、小写字母、数字和特殊字符(!@$%^-_=+[{}]:,./?)中的三种。

  • 密码不能包含用户名或用户名的逆序。

默认取值

不涉及

表7 NodeItem

参数

是否必选

参数类型

描述

uid

String

节点ID

表8 TaskStatus

参数

是否必选

参数类型

描述

jobID

String

任务ID,供调用者查询任务进度。

响应参数

状态码: 200

表9 响应Body参数

参数

参数类型

描述

apiVersion

String

API版本,固定值“v3”。

kind

String

API类型,固定值“RemoveNodesTask”。

spec

RemoveNodesSpec object

配置信息

status

TaskStatus object

任务状态

表10 RemoveNodesSpec

参数

参数类型

描述

login

Login object

节点的登录方式。密钥对和密码登录方式二者必选其一。

说明:

更新节点池时,不支持修改此参数

nodes

Array of NodeItem objects

待操作节点列表,当前最多支持同时移除200个节点。

表11 Login

参数

参数类型

描述

sshKey

String

参数解释

选择密钥对方式登录时的密钥对名称。

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

userPassword

UserPassword object

参数解释

选择密码方式登录时的账号密码信息,之后可通过此账号密码登录节点。

约束限制

不涉及

表12 UserPassword

参数

参数类型

描述

username

String

参数解释

登录账号,默认为“root”。

约束限制

不涉及

取值范围

不涉及

默认取值

root。

password

String

参数解释

登录密码,若创建节点通过用户名密码方式,即使用该字段,则响应体中该字段作屏蔽展示。

约束限制

创建节点时password字段需要加盐加密,具体方法请参见创建节点时password字段加盐加密

取值范围

密码复杂度要求:

  • 长度为8-26位。

  • 密码至少必须包含大写字母、小写字母、数字和特殊字符(!@$%^-_=+[{}]:,./?)中的三种。

  • 密码不能包含用户名或用户名的逆序。

默认取值

不涉及

表13 NodeItem

参数

参数类型

描述

uid

String

节点ID

表14 TaskStatus

参数

参数类型

描述

jobID

String

任务ID,供调用者查询任务进度。

请求示例

移除节点

PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/nodes/operation/remove

{
  "spec" : {
    "login" : {
      "sshKey" : "KeyPair-001"
    },
    "nodes" : [ {
      "uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }, {
      "uid" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
    } ]
  }
}

响应示例

状态码: 200

表示在指定集群下移除节点的作业下发成功。

{
  "spec" : {
    "login" : {
      "sshKey" : "KeyPair-001"
    },
    "nodes" : [ {
      "uid" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }, {
      "uid" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
    } ]
  },
  "status" : {
    "jobID" : "2ec9b78d-9368-46f3-8f29-d1a95622a568"
  }
}

SDK代码示例

SDK代码示例如下。

移除节点

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cce.v3.region.CceRegion;
import com.huaweicloud.sdk.cce.v3.*;
import com.huaweicloud.sdk.cce.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class RemoveNodeSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        CceClient client = CceClient.newBuilder()
                .withCredential(auth)
                .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                .build();
        RemoveNodeRequest request = new RemoveNodeRequest();
        request.withClusterId("{cluster_id}");
        RemoveNodesTask body = new RemoveNodesTask();
        List<NodeItem> listSpecNodes = new ArrayList<>();
        listSpecNodes.add(
            new NodeItem()
                .withUid("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
        );
        listSpecNodes.add(
            new NodeItem()
                .withUid("yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy")
        );
        Login loginSpec = new Login();
        loginSpec.withSshKey("KeyPair-001");
        RemoveNodesSpec specbody = new RemoveNodesSpec();
        specbody.withLogin(loginSpec)
            .withNodes(listSpecNodes);
        body.withSpec(specbody);
        request.withBody(body);
        try {
            RemoveNodeResponse response = client.removeNode(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

移除节点

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcce.v3.region.cce_region import CceRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcce.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = CceClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CceRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RemoveNodeRequest()
        request.cluster_id = "{cluster_id}"
        listNodesSpec = [
            NodeItem(
                uid="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
            ),
            NodeItem(
                uid="yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
            )
        ]
        loginSpec = Login(
            ssh_key="KeyPair-001"
        )
        specbody = RemoveNodesSpec(
            login=loginSpec,
            nodes=listNodesSpec
        )
        request.body = RemoveNodesTask(
            spec=specbody
        )
        response = client.remove_node(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

移除节点

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := cce.NewCceClient(
        cce.CceClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RemoveNodeRequest{}
	request.ClusterId = "{cluster_id}"
	var listNodesSpec = []model.NodeItem{
        {
            Uid: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        },
        {
            Uid: "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
        },
    }
	sshKeyLogin:= "KeyPair-001"
	loginSpec := &model.Login{
		SshKey: &sshKeyLogin,
	}
	specbody := &model.RemoveNodesSpec{
		Login: loginSpec,
		Nodes: listNodesSpec,
	}
	request.Body = &model.RemoveNodesTask{
		Spec: specbody,
	}
	response, err := client.RemoveNode(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

表示在指定集群下移除节点的作业下发成功。

错误码

请参见错误码

相关文档