You can call DescribeScalingConfigItemV2 operation to query the details of a scaling configuration items.

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 DescribeScalingConfigItemV2

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: DescribeScalingConfigItemV2.

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.

ScalingConfigItemId String Yes SRB-0F2A154CFD4D****

Scaling configuration items ID. You can call ListScalingConfigItemV2 View scaling configuration items ID.

ScalingGroupBizId String Yes SGB-8E52011DD26C****

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
ConfigItemInformation String {"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"}

The information about the configuration items. The information varies with the configuration items type. 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"}
    • time-based schedule {"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 SCALING_RULE

The type of the configuration parameters. Valid values:

  • SCALING_RUL: scaling rule
  • SCALING_STRATEGY: scaling policy
RequestId String 6C96FD2C-95A0-4C03-8A19-7D84A4BAAA1E

The ID of the request.

ScalingConfigItemBizId String SRB-0F2A154CFD4D****

Scaling configuration items ID.

ScalingGroupBizId String SGB-0F2A154CFD4D****

The ID of the scaling group.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeScalingConfigItemV2
&ConfigItemType=SCALING_RULE
&RegionId=cn-hangzhou
&ScalingConfigItemId=SCB-8E52011DD26123****
&ScalingGroupBizId=SGB-8E52011DD26C****
&<common request parameters> 

Sample success responses

XML format

<RequestId>6C96FD2C-95A0-4C03-8A19-7D84A4BAAA1E</RequestId>
<ScalingConfigItemBizId>SRB-0F2A154CFD4D****</ScalingConfigItemBizId>
<ScalingGroupBizId>SGB-0F2A154CFD4D****</ScalingGroupBizId>
<ConfigItemInformation> <ScalingGroupBizId> SGB-0F2A154CFD4D**** </ScalingGroupBizId> {"ruleName": "triggered by payload", "adjustmentType": "QUANTITY_CHANGE_IN_CAPACITY", "coolDownTime": 100, "ruleParam": { "metricName": "YarnFreeCores", "period": 10, "statistics": "xxx", "comparisonOperator": "\u003e\u003d", "threshold": 10, "evaluationCount": 1 }, "adjustmentValue": 1, "ruleType": "BY_LOAD", "configItemType": "SCALING_RULE"} </ConfigItemInformation>
<ConfigItemType>SCALING_RULE</ConfigItemType>

JSON Syntax

{
    "RequestId":"6C96FD2C-95A0-4C03-8A19-7D84A4BAAA1E",
    "ScalingConfigItemBizId":"SRB-0F2A154CFD4D****",
    "ScalingGroupBizId":"SGB-0F2A154CFD4D****",
    "ConfigItemInformation":"{ \" ruleName\": \" trigger by load \", \" adjustmentType\":" QUANTITY_CHANGE_IN_CAPACITY ", " coolDownTime ": 100," ruleParam ": { \" metricName\": \" YarnFreeCores\", \" period\": 10, \" statistics\": \" xxx\", \" comparisonOperator\":" \u003e \u003d ", \" threshold\": 10, \" evaluationCount\": 1 }, \" adjustmentValue\": 1, \" ruleType\": \"BY_LOAD\", \"configItemType\": \"SCALING_RULE\" }",
    "ConfigItemType":"SCALING_RULE"
}