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

调试

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

请求头

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

请求语法

post /api/v2/clusters/{ClusterId} http|https

请求参数

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

集群ID。

count Integer 3

扩容节点数量。

worker_instance_charge_type String PrePaid

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

  • 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

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

  • 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

节点系统盘大小,单位GB。

worker_data_disk Boolean true

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

  • true:表示worker节点挂载数据盘。
  • false:表示worker节点不挂载数据盘。
key_pair String secrity-key

密钥登录时的密钥对对名称,和login_password二选一。

login_password String Hello@1234

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

cloud_monitor_flags Boolean true

节点是否安装云监控。

cpu_policy String none

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

disable_rollback Boolean true

节点添加失败是否回滚。

image_id String ""

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

user_data String ""

节点自定义数据,Windows 支持 bat 和 powershell 两种格式,在 Base64 编码前,第一行为[bat] 或者 [powershell]。Linux 支持 shell 脚本,更多的格式请参见 cloud-init | 查看详情

如果您使用的自定义脚本大小大于 1 KB,建议您将脚本上传到 OSS,通过 OSS 内网端点拉取脚本执行。

创建集群或添加节点提交成功不代表实例自定义脚本执行成功,请自行确定脚本执行情况。

runtime Object

节点容器运行时。

name String docker

容器运行时名称。

version String 19.03.5

容器运行时版本。

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

虚拟交换机ID。

worker_instance_types Array of String ecs.c5.xlarge

节点类型。

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

RDS实例。

worker_data_disks Array

节点数据盘配置。

category String cloud_ssd

数据盘类型。

encrypted String false

数据盘是否加密。

size String 120

数据盘大小。

tags Array

节点标签信息。

key String tier

标签key。

value String frontend

标签值。

taints Array

节点污点信息。

effect String NoSchedule

调度策略。

key String node_type

污点key。

value String prod

污点值。

返回数据

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

集群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":"c82e6987e2961451182edacd7****",
    "count":1,
    "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":[
        {
            "key":"tier",
            "value":"frontend"
        }
    ]
}

正常返回示例

XML 格式

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

JSON 格式

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

错误码

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