You can call AddScalingConfigItemV2 operation to add a scaling configuration item.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes AddScalingConfigItemV2

The operation that you want to perform. This parameter is required for API requests that you create by piecing together HTTP or HTTPS URLs. Valid values: AddScalingConfigItemV2.

ConfigItemInformation String Yes {"ruleName": "triggered by payload", "adjustmentType": "QUANTITYCHANGEINCAPACITY", "cooltime": 100, "ruleParam": { "metricName": "YarnFreeCores", "period": 10, "statistics": "xxx", "comparisonOperator": "\u003e\u003d", "threshold": 10, "evaluationCount": 1 }, "adjustmentValue": 1, "ruleType": "BYLOAD", "configItemType": "SCALING_RULE"}

Configuration Items value in the JSON format varies with different types. Valid values:

  • SCALING_RULE:

    -Trigger by load {"ruleName": "triggered by payload", "adjustmentType": "QUANTITY_CHANGE_IN_CAPACITY", "cooltime": 100, "ruleParam": { "metricName": "YarnFreeCores", "period": 10, "statistics": "xxx", "comparisonOperator": "\u003e\u003d", "threshold": 10, "evaluationCount": 1 }, "adjustmentValue": 1, "ruleType": "BY_LOAD", "configItemType": "SCALING_RULE"}

    -Timed scheduling {"ruleName": "timed scheduling", "adjustmentType": "QUANTITY_CHANGE_IN_CAPACITY", "cooltime": 100, "ruleParam": { "recurrenceType": "Daily", "recurrenceValue": "1", "recurrenceEndTime": "2020-07-22T03:01Z", "launchtme": "" 2020-07-22T03:07Z ", " launchExpirationTime ": 0 }, " adjustmentValue ": 1, " ruleType ": "SCHEDULED", "configItemType": "SCALING_RULE"}

    -Fixed-point execution {"ruleName": "scheduled execution", "adjustmentType": "QUANTITY_CHANGE_IN_CAPACITY", "coolDownTime": 100, "ruleParam": { "launchTime": "2020-07-22T03:09Z", "launchExpirationTime": 1 }, "adjustmentValue": 1, "ruleType": "BY_TIME_ONCE", "configItemType": "SCALING_RULE"}

  • SCALING_STRATEGY: { "spotStrategy": "NoSpot", "spotPriceLimits": 0.01, "instanceTypeList": [], "sysDiskCategory": "cloud_essd", "sysDiskSize": { "value": 40.0, "unit": "GIGABYTE" }, "dataDiskCategory": "cloud_essd", "dataDiskSize": { "value": 40.0, "unit": "GIGABYTE" }, "dataDiskCount": 4, "scalingMaxSize": 1, "scalingMinSize": 1, "defaultCoolDownTime": 0, "scalingTimeoutPolice": { "timeoutPolicy": "ROLLBACK" }, "nodeOfflineMode": "NORMAL", "nodeOfflineModeParam": { "timeoutMs": 0 }, "triggerMode": "Scheduled", "multiAvailablePolicy": "PRIORITY", "multiAvailablePolicyParam": { "onDemandBaseCapacity": 0, "onDemandPercentageAboveBaseCapacity": 0, "spotInstanceRemedy": 0, "spotInstance": false }, "configItemType": "SCALING_STRATEGY" }
ConfigItemType String Yes SCALING_RULE

The type of the configuration parameters. Valid values:

  • SCALING_RULE: scaling rule
  • SCALING_STRATEGY: scaling policy
RegionId String Yes cn-hangzhou

The region ID of the instance. You can call DescribeRegions Interface to view the latest list of Alibaba Cloud regions.

ScalingGroupBizId String Yes SGB-A4521231C****

The ID of the scaling group. You can call ListScalingGroupV2 View the scaling group ID.

ResourceGroupId String No rg-acfmv6jutt6****

The ID of the resource group. You can call ListResourceGroups View the resource group ID.

Response parameters

Parameter Type Example Description
Data String SRB-DA382429BA82****

The new configuration items ID.

RequestId String 6C96FD2C-95A0-4C03-8A19-7D84A4BAAA1E

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=AddScalingConfigItemV2 
&ConfigItemInformation={ "ruleName": "Trigger by payload", "adjustmentType": "QUANTITYCHANGEINCAPACITY", "coolDownTime": 100, "ruleParam": { "metricName": "YarnFreeCores", "period": 10, "statistics": "xxx", "comparisonOperator": "\u003e\u003d", "threshold": 10, "evaluationCount": 1 }, " adjustmentValue ": 1, " ruleType ": " BYLOAD ", " configItemType ": " SCALING_RULE " } 
&ConfigItemType=SCALING_RULE 
&RegionId=cn-hangzhou 
&ScalingGroupBizId=SGB-A4521231C**** 
&<common request parameters> 

Sample success responses

XML format

<RequestId>6C96FD2C-95A0-4C03-8A19-7D84A4BAAA1E</RequestId>
<Data>SRB-DA382429BA82****</Data>

JSON Syntax

{
    "RequestId":"6C96FD2C-95A0-4C03-8A19-7D84A4BAAA1E",
    "Data":"SRB-DA382429BA82****"
}