节点管理

更新时间：2026-07-23

接口总览

接口名称	说明	方法	路径
UpdateInstanceGroup	节点组变配（新增/扩容/缩容/变更规格/磁盘变配）	POST	/v2/bcc/instanceGroup/update
DeleteInstanceGroup	删除节点组	POST	/v2/bcc/instanceGroup/delete
ListClusterNodes	查询集群节点列表	POST	/v2/bcc/instanceGroup/detail
DecommissionNodes	缩容集群节点（下线服务）	POST	/v2/bcc/instanceGroup/decommission
ChangeNodePassword	修改节点登录密码	POST	/v2/bcc/instance/changePass

UpdateNodeGroup 节点组变配

接口描述

节点组变配接口。当前支持新增节点组、扩容、缩容/释放、变更节点规格、磁盘变配等操作，通过 items[].config.type 区分：

操作	type	instanceGroups 每项关键字段
新增节点组	`newInstanceGroup`	`name`/ `type` / `instanceType` / `instanceCount` / `rootDiskSizeInGB` / `rootDiskMediumType` / `cds`
扩容节点	`scaleOut`	`id` / `instanceCount`
释放节点	`scaleOut`	`id` / `instanceCount`/ `shrinkInstanceIds`
变更节点规格	`scaleUp`	`id` / `instanceType`
磁盘变配	`diskScaleUp`	`id` / `cds`（`cds[].sizeInGB` 须严格大于原容量）

请求结构

Plain Text

1POST /v2/bcc/instanceGroup/update HTTP/1.1
2Content-Type: application/json
3
4{
5    "items": [
6        {
7            "config": {
8                "clusterId": "clusterId",
9                "type": "type",
10                "instanceGroups": [
11                    {
12                        "id": "id",
13                        "name": "name",
14                        "type": "type",
15                        "instanceType": "instanceType",
16                        "instanceCount": "instanceCount",
17                        "shrinkInstanceIds": ["shrinkInstanceIds"],
18                        "rootDiskSizeInGB": "rootDiskSizeInGB",
19                        "rootDiskMediumType": "rootDiskMediumType",
20                        "cds": [
21                            {
22                                "sizeInGB": "sizeInGB",
23                                "mediumType": "mediumType"
24                            }
25                        ],
26                        "selectService": {"selectService": ["selectService"]}
27                    }
28                ]
29            }
30        }
31    ]
32}

请求参数

名称	类型	是否必须	参数位置	参数描述
items	List	是	RequestBody	订单项列表，不可为空，仅取第一项
items[].config	InstanceGroupItem	是	RequestBody	订单配置

响应参数

参数名	参数类型	参数描述
result.bmrOrderId	String	BMR 订单 ID
result.clusterId	String	集群 ID

请求示例（新增节点组）

                JSON
                
            

                {
    "items": [
        {
            "config": {
                "clusterId": "0181b994-576a-4a00-b04e-f6fa9d5eee48",
                "type": "newInstanceGroup",
                "instanceGroups": [
                    {
                        "name": "bmr-master-extend",
                        "type": "MASTER_EXTEND",
                        "instanceType": "bmr.g4.c8m32",
                        "instanceCount": 1,
                        "rootDiskSizeInGB": 100,
                        "rootDiskMediumType": "ssd",
                        "cds": [{"sizeInGB": 500, "mediumType": "ssd"}],
                        "selectService": {
                            "SPARK": [
                                "spark3-history-server"
                            ]
                        }
                    }
                ]
            }
        }
    ]
}
            

请求示例（节点组扩容）

                JSON
                
            

                {
    "items": [
        {
            "config": {
                "clusterId": "0181b994-576a-4a00-b04e-f6fa9d5eee48",
                "type": "scaleOut",
                "instanceGroups": [
                    {"id": "ig-xxxx", "instanceCount": 5}
                ]
            }
        }
    ]
}
            

请求示例（节点组缩容）

                JSON
                
            

                {
    "items": [
        {
            "config": {
                "clusterId": "0181b994-576a-4a00-b04e-f6fa9d5eee48",
                "type": "scaleOut",
                "instanceGroups": [
                    {
                        "id": "ig-xxxx",
                        "type": "Task",
                        "instanceCount": 2,
                        "shrinkInstanceIds": ["i-xxxx"]
                    }
                ]
            }
        }
    ]
}
            

请求示例（变更节点规格）

                JSON
                
            

                {
    "items": [
        {
            "config": {
                "clusterId": "0181b994-576a-4a00-b04e-f6fa9d5eee48",
                "type": "scaleUp",
                "instanceGroups": [
                    {"id": "ig-xxxx", "instanceType": "bmr.g4.c8m32"}
                ]
            }
        }
    ]
}
            

请求示例（磁盘变配）

                JSON
                
            

                {
    "items": [
        {
            "config": {
                "clusterId": "0181b994-576a-4a00-b04e-f6fa9d5eee48",
                "type": "diskScaleUp",
                "instanceGroups": [
                    {"id": "ig-xxxx", "cds": [{"sizeInGB": 500, "mediumType": "ssd"}]}
                ]
            }
        }
    ]
}
            

响应示例

                JSON
                
            

                {
    "success": true,
    "status": 200,
    "result": {
        "bmrOrderId": "order-xxxx",
        "clusterId": "0181b994-576a-4a00-b04e-f6fa9d5eee48"
    }
}
            

DeleteNodeGroup 删除节点组

接口描述

删除集群中的（空）节点组。

请求结构

Plain Text

1POST /v2/bcc/instanceGroup/delete HTTP/1.1
2Content-Type: application/json
3
4{
5    "instanceGroupId": "instanceGroupId"
6}

请求参数

名称	类型	是否必须	参数位置	参数描述
instanceGroupId	String	是	RequestBody	待删除的节点组 ID

响应参数

参数名	参数类型	参数描述
result	Null	成功时为空

请求示例

                JSON
                
                {
    "instanceGroupId": "ig-xxxx"
}

响应示例

                JSON
                
            

                {
    "success": true,
    "status": 200,
    "result": null
}
            

ListClusterNodes 查询集群节点列表

接口描述

查询集群下的节点组及节点详情。

请求结构

Plain Text

1POST /v2/bcc/instanceGroup/detail HTTP/1.1
2Content-Type: application/json
3
4{
5    "clusterId": "clusterId"
6}

请求参数

名称	类型	是否必须	参数位置	参数描述
clusterId	String	是	RequestBody	集群 ID

响应参数

参数名	参数类型	参数描述
result.maxCount	Int	节点组最大可扩容数
result.nodeGroups	List	节点组列表

请求示例

                JSON
                
            

                {
    "clusterId": "0181b994-576a-4a00-b04e-f6fa9d5eee48",
    "filterEmptyInstanceGroup": true,
    "filterLocalDiskInstanceGroup": false
}
            

响应示例

                JSON
                
            

                {
    "success": true,
    "status": 200,
    "result": {
        "maxCount": 50,
        "nodeGroups": [
            {
                "id": "ig-xxxx",
                "name": "MASTER",
                "type": "Master",
                "spec": "bmr.g1.xlarge",
                "cpu": 4,
                "memory": 16,
                "isSpot": false,
                "cds": [{"sizeInGB": 200, "mediumType": "ssd", "attributes": []}],
                "diskType": "cds",
                "rootDiskSizeInGB": 50,
                "rootDiskMediumType": "ssd",
                "requestedInstanceCount": 1,
                "totalInstanceCount": 1,
                "runningInstanceCount": 1,
                "maxCount": 1,
                "minCount": 1,
                "state": "Running",
                "payType": "Prepaid",
                "instanceType": {"name": "bmr.g1.xlarge", "cpu": 4, "memory": 16, "disk": 200, "diskType": "ssd"},
                "instances": [
                    {
                        "id": "i-xxxx",
                        "instanceName": "bmr-master-1.bmr.local",
                        "status": {"state": "Running", "creationDateTime": "2026-06-01T10:00:00Z"},
                        "privateIpAddress": "10.0.0.10",
                        "sshPort": 22,
                        "volumes": {"/data1": [{"size": 200, "mediumType": "ssd"}]}
                    }
                ]
            }
        ]
    }
}
            

DecommissionNodes 缩容集群节点（下线服务）

接口描述

对集群节点执行下线（退役）操作，平滑下线节点上的服务，不释放节点

请求结构

Plain Text

1POST /v2/bcc/instanceGroup/decommission HTTP/1.1
2Content-Type: application/json
3
4{
5    "clusterId": "clusterId",
6    "instanceIds": ["instanceIds"],
7    "shardNum": "shardNum",
8    "options": {
9        "yarnGraceful": "yarnGraceful",
10        "gracefulTimeout": "gracefulTimeout"
11    }
12}

请求参数

名称	类型	是否必须	参数位置	参数描述
clusterId	String	是	RequestBody	集群 ID
instanceIds	List	是	RequestBody	待下线的实例 ID 列表。与 shardNum 互斥（两者不能同时 >0）
shardNum	Int	否	RequestBody	分片数（ClickHouse 等按分片下线场景）。与 instanceIds 互斥
options	Map<String,String>	否	RequestBody	附加选项； yarnGraceful: 是否优雅退场，默认为 false gracefulTimeout：优雅退场等待时间，默认为 3600

响应参数

参数名	参数类型	参数描述
result	Null	成功时为空

请求示例

                JSON
                
            

                {
    "clusterId": "0181b994-576a-4a00-b04e-f6fa9d5eee48",
    "instanceIds": ["i-xxxx"],
    "options": {
        "yarnGraceful": "true",
        "gracefulTimeout": "60"
    }
}
            

响应示例

                JSON
                
            

                {
    "success": true,
    "status": 200,
    "result": null
}
            

ChangeNodePassword 修改节点登录密码

接口描述

修改特定节点登录密码

请求结构

Plain Text

1POST /v2/bcc/instance/changePass HTTP/1.1
2Content-Type: application/json
3
4{
5    "clusterId": "clusterId",
6    "instanceId": "instanceId",
7    "adminInstancePass": "adminPassword"
8}

请求参数

名称	类型	是否必须	参数位置	参数描述
clusterId	String	是	RequestBody	集群 ID
instanceId	String	是	RequestBody	修改密码的示例 instanceId i-xxx
adminInstancePass	String	是	RequestBody	修改后的密码，加密传输

响应参数

参数名	参数类型	参数描述
result	Null	成功时为空

请求示例

                JSON
                
            

                {
    "clusterId": "0181b994-576a-4a00-b04e-f6fa9d5eee48",
    "instanceIds": "i-xxxx",
    "adminInstancePass": "<encryptedPassword>"
}
            

响应示例

                JSON
                
            

                {
    "success": true,
    "status": 200,
    "result": null
}
            

错误返回码

接口	HTTP Status	Code	Message	说明
UpdateNodeGroup	400	InvalidParameter	Invalid request parameter, resize order items should not be empty	items 为空
UpdateNodeGroup	400	InvalidArguments	Invalid arguments	instanceGroups 为空、未发生有效变更，或 type/规格/磁盘容量等取值非法
UpdateNodeGroup	400	UnsupportedClusterStatus	The clusterStatus not support	集群非 Active 或正处于伸缩中，不允许下单
UpdateNodeGroup	403	OperateForbid	The requested operation is forbidden for this resource	当前集群类型/用户不允许执行该变更
UpdateNodeGroup	404	ClusterNotFound	The cluster not found	集群不存在
UpdateNodeGroup	404	GroupNotFound	The instance group not found	instanceGroups 中引用的节点组不存在
UpdateNodeGroup	404	InstanceNotFound	The instance not found	shrinkInstanceIds 中的实例不存在
DeleteNodeGroup	400	InvalidParameter	Invalid request parameter	instanceGroupId 缺失或非法
DeleteNodeGroup	404	GroupNotFound	The instance group not found	节点组不存在
DeleteNodeGroup	403	OperateForbid	The requested operation is forbidden for this resource	节点组不允许删除（当前实现未强校验是否为空）
ListClusterNodes	400	InvalidParameter	Invalid request parameter	clusterId 缺失
ListClusterNodes	404	ClusterNotFound	The cluster not found	集群不存在
DecommissionNodes	400	InvalidParameter	Invalid request parameter	参数绑定失败或 instanceIds 与 shardNum 同时大于 0
DecommissionNodes	400	InvalidArguments	Invalid arguments	shardNum 仅 ClickHouse 集群支持，其他镜像类型传入会报错
DecommissionNodes	400	UnsupportedClusterStatus	The clusterStatus not support	集群状态不允许下线（如已在调整中）
DecommissionNodes	404	ClusterNotFound	The cluster not found	集群不存在
DecommissionNodes	404	InstanceNotFound	The instance not found	instanceIds 中的实例不属于该集群或不存在
DecommissionNodes	403	OperateForbid	The requested operation is forbidden for this resource	当前集群/用户不允许执行下线

评价此篇文章

有帮助没帮助

服务管理

用户管理

MapReduce

节点管理

接口总览

UpdateNodeGroup 节点组变配

接口描述

请求结构

请求参数

响应参数

请求示例（新增节点组）

请求示例（节点组扩容）

请求示例（节点组缩容）

请求示例（变更节点规格）

请求示例（磁盘变配）

响应示例

DeleteNodeGroup 删除节点组

接口描述

请求结构

请求参数

响应参数

请求示例

响应示例

ListClusterNodes 查询集群节点列表

接口描述

请求结构

请求参数

响应参数

请求示例

响应示例

DecommissionNodes 缩容集群节点（下线服务）

接口描述

请求结构

请求参数

响应参数

请求示例

响应示例

ChangeNodePassword 修改节点登录密码

接口描述

请求结构

请求参数

响应参数

请求示例

响应示例

错误返回码