调用ScaleOutCluster增加集群中Worker节点的数量(支持多可用区实例)。

说明 目前节点的操作均合入节点池,ACK不再维护ScaleOutCluster接口。请通过扩容节点池操作增加集群的Worker节点。具体操作,请参见扩容节点池

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求语法

POST /api/v2/clusters/ClusterId HTTP/1.1 
Content-Type:application/json
{
  "count" : Long,
  "key_pair" : "String",
  "login_password" : "String",
  "vswitch_ids" : [ "String" ],
  "worker_instance_charge_type" : "String",
  "worker_period" : Long,
  "worker_period_unit" : "String",
  "worker_auto_renew" : Boolean,
  "worker_auto_renew_period" : Long,
  "worker_instance_types" : [ "String" ],
  "worker_system_disk_category" : "String",
  "worker_system_disk_size" : Long,
  "worker_data_disks" : [ {
    "category" : "String",
    "size" : Long,
    "encrypted" : "String",
    "auto_snapshot_policy_id" : "String"
  } ],
  "cloud_monitor_flags" : Boolean,
  "cpu_policy" : "String",
  "image_id" : "String",
  "user_data" : "String",
  "rds_instances" : [ "String" ],
  "tags" : [ {
    "key" : "String",
    "value" : "String"
  } ],
  "taints" : [ {
    "key" : "String",
    "value" : "String",
    "effect" : "String"
  } ],
  "runtime" : {
    "name" : "String",
    "version" : "String"
  }
}

请求参数

表 1. 请求Path参数
参数名称 类型 是否必选 示例 说明
ClusterId String c82e6987e2961451182edacd74faf****

集群ID。

表 2. 请求Body参数
参数名称 类型 是否必选 示例 说明
count Long 3

扩容节点数量。

key_pair String secrity-key

密钥对名称,和login_password二选一。

login_password String Hello@1234

SSH登录密码,和key_pair 二选一。密码规则为8~30个字符,且至少同时包含三项(大小写字母、数字和特殊符号)。

vswitch_ids Array of String vsw-2ze4jvvvade1yk899****

扩容节点的虚拟交换ID列表,默认是创建集群的交换机列表。

worker_instance_charge_type String PrePaid

Worker节点付费类型,取值:

  • PrePaid:包年包月。
  • PostPaid:按量付费。

默认值:PostPaid

worker_period Long 1

Worker节点包年包月时长,当worker_instance_charge_type取值为PrePaid时才生效且为必选值。

取值范围:{1, 2, 3, 6, 12, 24, 36, 48, 60}。

默认值:1。

worker_period_unit String Month

Wroker节点付费周期,当付费类型为PrePaid的时需要指定周期。

取值:Month,当前只支持以月为周期。

worker_auto_renew Boolean true

Worker节点是否开启自动续费,当worker_instance_charge_type取值为PrePaid时才生效,取值:

  • true:自动续费。
  • false:不自动续费。

默认值:true

worker_auto_renew_period Long 6

Worker节点自动续费周期,当选择包年包月付费类型时才生效,且为必选值。

取值范围:{1, 2, 3, 6, 12}。

默认值:1

worker_instance_types Array of String ecs.c5.xlarge

Worker节点实例规格,至少要指定一个实例规格。更多详细信息,请参见实例规格族

说明 实例规格优先级随着在数据中的位置增大依次降低。当无法根据优先级较高的实例规格创建出实例时,会自动选择下一优先级的实例规格来创建实例。
worker_system_disk_category String cloud_efficiency

Worker节点系统盘类型,取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
  • cloud_essd:ESSD云盘。

默认值:cloud_ssd

worker_system_disk_size Long 120

Worker节点系统盘大小,单位为GiB。

取值范围:[40,500]。

默认值:120

worker_data_disks Array of data_disk

Worker节点数据盘类型、大小等配置的组合。

cloud_monitor_flags Boolean true

集群是否安装云监控插件。取值:

  • true:安装云监控插件。
  • false:不安装云监控插件。

默认值:false

cpu_policy String none

节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略:

  • static:允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。
  • none:表示启用现有的默认CPU亲和性方案。

默认值:none

image_id String m-bp16z7xko3vvv8gt****

节点自定义镜像,默认使用系统镜像。当选择自定义镜像时,将取代默认系统镜像。请参见自定义镜像

user_data String IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFD****

节点池自定义数据。更多详情,请参见生成实例自定义数据

rds_instances Array of String rm-2zev748xi27xc****

RDS实例名称。

tags Array of tag

节点标签。标签定义规则:

  • 标签由区分大小写的键值对组成,您最多可以设置20个标签。
  • 标签键不可以重复,最长为64个字符;标签值可以为空,最长为128个字符。标签键和标签值都不能以“aliyun”、“acs:”、“https://”或“http://”开头。详情请参见Labels and Selectors
taints Array of taint

节点污点信息。污点和容忍度(Toleration)相互配合,可以用来避免Pod被分配到不合适的节点上。更多信息,请参见taint-and-toleration

runtime runtime

集群内容器运行时。

响应体语法

HTTP/1.1 200
Content-Type:application/json
{
  "cluster_id" : "String",
  "request_id" : "String",
  "task_id" : "String"
}

响应参数

表 3. 响应Body参数
参数名称 类型 示例 说明
cluster_id String c82e6987e2961451182edacd74faf****

集群ID。

request_id String 687C5BAA-D103-4993-884B-C35E4314A1E1

请求ID。

task_id String T-5a54309c80282e39ea00002f

任务ID。

扩容ACK集群示例

请求示例

POST /api/v2/clusters/c82e6987e2961451182edacd74faf**** HTTP/1.1 
Content-Type:application/json
{
  "count" : 3,
  "key_pair" : "secrity-key",
  "login_password" : "Hello@1234",
  "vswitch_ids" : [ "vsw-2ze4jvvvade1yk899****" ],
  "worker_instance_charge_type" : "PrePaid",
  "worker_period" : 1,
  "worker_period_unit" : "Month",
  "worker_auto_renew" : true,
  "worker_auto_renew_period" : 6,
  "worker_instance_types" : [ "ecs.c5.xlarge" ],
  "worker_system_disk_category" : "cloud_efficiency",
  "worker_system_disk_size" : 120,
  "worker_data_disks" : [ {
    "category" : "cloud_ssd",
    "size" : 40,
    "encrypted" : "true",
    "auto_snapshot_policy_id" : "sp-2zej1nogjvovnz4z****"
  } ],
  "cloud_monitor_flags" : true,
  "cpu_policy" : "none",
  "image_id" : "m-bp16z7xko3vvv8gt****",
  "user_data" : "IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFD****",
  "rds_instances" : [ "rm-2zev748xi27xc****" ],
  "tags" : [ {
    "key" : "env",
    "value" : "prod"
  } ],
  "taints" : [ {
    "key" : "key",
    "value" : "value",
    "effect" : "NoSchedule"
  } ],
  "runtime" : {
    "name" : "docker",
    "version" : "19.03.5"
  }
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<cluster_id>c82e6987e2961451182edacd74faf****</cluster_id>
<request_id>687C5BAA-D103-4993-884B-C35E4314A1E1</request_id>
<task_id>T-5a54309c80282e39ea00002f</task_id>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "cluster_id" : "c82e6987e2961451182edacd74faf****",
  "request_id" : "687C5BAA-D103-4993-884B-C35E4314A1E1",
  "task_id" : "T-5a54309c80282e39ea00002f"
}

错误码

访问错误中心查看更多错误码。

开发者资源

  • SDK

    阿里云为您提供多种语言的SDK,帮助您快速通过API集成阿里云的产品和服务,推荐您使用SDK调用API,已免除您手动签名验证。

  • OpenAPI Explorer

    快速检索,可视化调试API,在线命令行工具,同步动态生成可执行的SDK代码示例。

  • 阿里云CLI

    阿里云资产管理和配置工具,可通过命令方式同时管理多个阿里云产品和服务,简单快捷,是您上云好帮手。