Predictive Scaling Instance Forecast API Overview - Auto Scaling - Alibaba Cloud - Auto Scaling

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ess:QueryPredictiveValue

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID	cn-hangzhou
StartTime	string	Yes	The beginning of the prediction time range. Specify the time in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mmZ.	2025-12-17T08:00Z
EndTime	string	Yes	The end of the prediction time range. Specify the time in the ISO 8601 standard in UTC. Format: yyyy-MM-ddTHH:mmZ.	2025-12-18T08:00Z
ScalingGroupId	string	Yes	The ID of the scaling group.	asg-2zee0wsy0zkdxxxxx
MetricName	string	Yes	The monitoring metric of the predictive scaling rule. Valid values: CpuUtilization: the average CPU utilization. IntranetRx: the inbound traffic over an internal network. IntranetTx: the outbound traffic over an internal network.	CpuUtilization
TargetValue	number	Yes	The current value of the monitoring metric for the predictive scaling rule.	60

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	FA5F448E-DC84-5EBC-B6D5-F659ADxxxx
PredictiveValues	object
PredictiveValue	array<object>	The number of predicted instances in the scaling group.
	object	The number of predicted instances in the scaling group.
Time	string	The point in time, in the yyyy-MM-ddTHH:mmZ format as defined in ISO 8601.	2025-12-17T10:00Z
Value	integer	The predicted number of instances.	3

Examples

Success response

JSON format

{
  "RequestId": "FA5F448E-DC84-5EBC-B6D5-F659ADxxxx",
  "PredictiveValues": {
    "PredictiveValue": [
      {
        "Time": "2025-12-17T10:00Z",
        "Value": 3
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.