文档平台 API 中心 容器服务 集群自动扩缩容相关接口 修改集群伸缩组是否启用缩容

修改集群伸缩组是否启用缩容

最近更新时间:2018-07-16 16:13:32

接口描述

本接口(ModifyClusterAsgScaleDown)用于修改集群伸缩组是否启用缩容,是否启用缩容是针对集群而言的,一旦启用,则对集群中所有伸缩组生效。

接口请求域名:

ccs.api.qcloud.com

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

参数名称 描述 必选 类型
clusterId 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段 String
scaleDownEnabled 是否启用缩容,非 0 表示启用 Int
expander 扩容算法,[random,most-pods,least-waste] Int
maxEmptyBulkDelete 每次最大缩容的完全空闲的节点数量,默认值 10 Int
maxTotalUnreadyPercentage unready 节点所占百分比,超过此比例后 CA 停止工作 Int
okTotalUnreadyCount unready 节点总数超过此数值时,CA 停止工作 Int
scaleDownDelay 扩容多久后开始考虑缩容条件,默认值 10 分钟 Int
scaleDownUnneededTime 节点连续多久空闲时被缩容,默认值 10 分钟 Int
scaleDownUnreadyTime 集群中 unready 状态的节点持续多久后被缩容,默认值 20 分钟 Int
skipNodesWithLocalStorage CA 是否缩容存在本地存储 Pod 的节点,默认不缩容 Int
skipNodesWithSystemPods CA 是否缩容存在 kube-system namespace 下 Pod 的节点,默认不缩容 Int
unregisteredNodeRemovalTime 在伸缩组中,但不在集群中的节点的缩容时间,默认 15 分钟 Int
scaleDownUtilizationThreshold 百分比。request 占用比小于此值时,尝试缩容 Int

输出参数

参数名称 描述 类型
code 公共错误码。0 表示成功,其他值表示失败 Int
codeDesc 业务侧错误码。成功时返回 Success,错误时返回具体业务错误原因 String
message 模块错误信息描述,与接口相关 String

示例

输入

  https://domain/v2/index.php?Action=ModifyClusterAsgScaleDown
  &clusterId=cls-xxxxxxxx
  &scaleDownEnabled=1
  &其它公共参数

输出

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "requestId": 4411
    }
}