跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/弹性伸缩组相关接口
POSTAuto-Scaling Group Operations起始版本 3.1.0同步需要认证

创建伸缩组云主机扩容规则

创建伸缩组云主机扩容规则

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • adjustmentTypeString必填

      扩容方式：增加指定数量云主机，按百分比增加云主机，增加云主机数量到指定值

    • adjustmentValueInteger必填

      增加大小

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • autoScalingGroupUuidString必填

      伸缩组UUID

    • typeString

      伸缩规则类型

    • cooldownLong

      伸缩规则触发后的冷却时间

    • resourceUuidString

      资源UUID。若指定，资源会使用该字段值作为UUID。

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签。

  • userTagsList

    用户标签。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryAutoScalingRuleInventory必填

    详情参考inventory

    • typeString必填

      伸缩组规则类型

    • descriptionString必填

      资源的详细描述

    • cooldownLong必填

      冷却时间

    • systemTagsList必填

      系统标签。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • nameString必填

      资源名称

    • uuidString必填

      资源的UUID，唯一标示该资源

    • scalingGroupUuidString必填

      扩缩容组UUID。

    • stateAutoScalingRuleState必填

      详情参考state

      • EnabledAutoScalingRuleState必填

        启用状态

      • DisabledAutoScalingRuleState必填

        关闭状态

    • statusAutoScalingRuleStatus必填

      详情参考status

      • CreatedAutoScalingRuleStatus必填

        已创建

      • WaitingForTriggerAutoScalingRuleStatus必填

        等待触发

      • TriggeringAutoScalingRuleStatus必填

        已触发

      • ErrorAutoScalingRuleStatus必填

        错误。

    • ruleTriggersList必填

      详情参考ruleTriggers

      • nameString必填

        资源名称

      • uuidString必填

        资源的UUID，唯一标示该资源

      • typeString必填

        触发器类型

      • ruleUuidString必填

        伸缩规则UUID

      • descriptionString必填

        资源的详细描述

      • stateString必填

        触发器状态

        • EnabledAutoScalingRuleState必填

          启用状态

        • DisabledAutoScalingRuleState必填

          关闭状态

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

POST/zstack/v1/autoscaling/rules/adding-new-instance

/zstack/v1/autoscaling/rules/adding-new-instance

操作 ID

CreateAutoScalingGroupAddingNewInstanceRule

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/autoscaling/rules/adding-new-instance' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"adjustmentType":"<adjustmentType>","adjustmentValue":1,"name":"<name>","description":"<description>","autoScalingGroupUuid":"<autoScalingGroupUuid>","type":"<type>","cooldown":1,"resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "type": "HealthProfile", "description": "just for test", "cooldown": 10.0, "state": "Enabled", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "name": "test-health-policy", "uuid": "f41b2b0ae44637a2af1985e362dc52d4" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史