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

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /api/v2/clusters/[ClusterId] HTTPS|HTTP

请求参数

名称 类型 是否必选 示例值 描述
ClusterId String c82e6987e2961451182edacd74faf****

扩容目标集群的集群ID。

count Integer 1

扩容实例数量。

key_pair String key-pair-xxxxx

keypair名称,和login_password二选一。

login_password String Hello1234

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

worker_data_disk Boolean true

是否挂载数据盘,可选择为:

  • true:表示worker节点挂载数据盘。
  • false:表示worker节点不挂载数据盘。
worker_instance_types List<String> ["ecs.i1.2xlarge"]

Worker节点ECS规格类型代码。更多详细信息,参见实例规格族

worker_instance_charge_type String PrePaid

Worker节点付费类型,可选值为:

  • PrePaid:预付费。
  • PostPaid:按量付费。

默认为按量付费。

worker_period Integer 1

包年包月时长,当worker_instance_charge_type取值为PrePaid时才生效且为必选值,取值范围:PeriodUnit=Month时,Period取值:{ “1”, “2”, “3”, “6”, “12”}。

worker_period_unit String Month

当指定为PrePaid的时候需要指定周期。Month:以月为计时单位。

worker_auto_renew Boolean true

是否开启Worker节点自动续费,可选值为:

  • true:自动续费。
  • false:不自动续费。
worker_auto_renew_period Integer 6

自动续费周期,当选择预付费和自动续费时才生效,且为必选值: PeriodUnit=Month时,取值{“1”, “2”, “3”, “6”, “12”}。

worker_system_disk_category String cloud_efficiency

Worker节点系统盘类型。

worker_system_disk_size Integer 120

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

cloud_monitor_flags Boolean true

是否安装云监控插件:

  • true:表示安装。
  • false:表示不安装。
cpu_policy String none

CPU策略。集群版本为1.12.6及以上版本支持static和none两种策略。默认为none。

disable_rollback Boolean true

失败是否回滚:

  • true:表示失败不回滚。
  • false:表示失败回滚。

默认为true,如果选择失败回滚,则会释放创建过程中所生产的资源,不推荐使用false。

vswitch_ids List<String> ["vsw-2ze4jvvvade1yk899****"]

节点交换机ID列表,交换机个数取值范围为1~3。为确保集群的高可用性,推荐您选择3个交换机,且分布在不同的可用区。

worker_data_disks Array [{"category":"cloud","size":"40","encrypted":"false"}]

Worker数据盘类型、大小等配置的组合。该参数只有在挂载Worker节点数据盘时有效,包含以下参数:

  • category:数据盘类型。取值范围:
    • cloud:普通云盘。
    • cloud_efficiency:高效云盘。
    • cloud_ssd:SSD云盘。
  • size:数据盘大小,单位为GiB。
  • encrypted:是否对数据盘加密,true|false。
tags Array [{"key":"tier","value":"backend"}]

给集群打tag标签:

  • key:标签名称。
  • value:标签值。
taints Array []

用于给节点做污点标记,通常用于Pods的调度策略。与之相对应的概念为:容忍(tolerance),若Pods上有相对应的tolerance标记,则可以容忍节点上的污点,并调度到该节点。

返回数据

名称 类型 示例值 描述
cluster_id String c82e6987e2961451182edacd74faf****

集群实例ID。

instanceId String Cccfd68c474454665ace07efce924****

扩容节点ID。

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

请求ID。

task_id String T-5a54309c80282e39ea00002f

任务ID。系统自动分配,用户查询任务状态。

示例

请求示例

POST /api/v2/clusters/[ClusterId] HTTP/1.1
公共请求头
{
    "ClusterId": "c82e6987e2961451182edacd74faf", 
    "key_pair":"common",
    "vswitch_ids":["vsw-uf684tfrpwup8gcsw****"],
    "worker_instance_types":["ecs.c5.xlarge"],
    "worker_system_disk_category":"cloud_efficiency",
    "worker_system_disk_size":120,
    "worker_data_disk":false,
    "worker_data_disks": [{"category": "cloud_ssd", "size": 500}],
    "tags":[],
    "count":1
}

请求示例补充说明

 {
     "key_pair":"keypair名称,和login_password 二选一",
    "vswitch_ids": "一台或多台虚拟交换机 ID,N 的取值范围为 [1, 3]",
    "worker_instance_types": "Worker实例规格多实例规格参数",
    "worker_system_disk_category": "Worker系统盘类型",
    "worker_system_disk_size": "Worker节点系统盘大小",
    "worker_data_disk":"是否挂载数据盘 true|false",
    "tags": "给集群打tag标签, 数组格式对象",
    "count":"扩容的数量",
    "worker_data_disks": "Worker节点数据盘配置"
}

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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