GetAutoScalingPolicy - E-MapReduce - Alibaba Cloud Documentation Center

Retrieves the details of a custom Auto Scaling policy.

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

emr:GetAutoScalingPolicy

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	c-b933c5aac8fe****
NodeGroupId	string	Yes	The node group ID.	ng-869471354ecd****

Response elements

Element	Type	Description	Example
	object	The data returned.
ScalingPolicy	object	The Auto Scaling policy.
NodeGroupId	string	The node group ID.	ng-869471354ecd****
ClusterId	string	The cluster ID.	c-b933c5aac8fe****
ScalingRules	array<object>	The list of scaling rules.
	object	A scaling rule.
RuleName	string	The name of the scaling rule.	scaling-out-memory
TriggerType	string	The type of the scaling rule. Valid values: TIME_TRIGGER: a time-based scaling rule. METRICS_TRIGGER: a metric-based scaling rule.	TIME_TRIGGER
ActivityType	string	The type of the scaling activity. Valid values: SCALE_OUT: scale-out. SCALE_IN: scale-in.	SCALE_OUT
AdjustmentType	string	The adjustment type.	CHANGE_IN_CAPACITY
AdjustmentValue	integer	The adjustment value. The value must be a positive integer. It specifies the number of instances to add or remove.	100
TimeTrigger	TimeTrigger	The description of the time-based scaling rule.
MetricsTrigger	MetricsTrigger	The description of the metric-based scaling rule.
CollationTimeZone	CollationTimeZone
ScalingPolicyId	string	The scaling policy ID.	asp-asduwe23znl***
Constraints	object	The constraints on the minimum and maximum number of nodes in the node group.
MaxCapacity	integer	The maximum number of nodes in the node group. Default value: 2000.	2000
MinCapacity	integer	The minimum number of nodes in the node group. Default value: 0.	0
RequestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Success response

JSON format

{
  "ScalingPolicy": {
    "NodeGroupId": "ng-869471354ecd****",
    "ClusterId": "c-b933c5aac8fe****",
    "ScalingRules": [
      {
        "RuleName": "scaling-out-memory",
        "TriggerType": "TIME_TRIGGER",
        "ActivityType": "SCALE_OUT",
        "AdjustmentType": "CHANGE_IN_CAPACITY",
        "AdjustmentValue": 100,
        "TimeTrigger": {
          "LaunchTime": "17:30",
          "StartTime": 1639714800000,
          "EndTime": 1639714800000,
          "LaunchExpirationTime": 600,
          "RecurrenceType": "WEEKLY",
          "RecurrenceValue": "MON,FRI,SUN"
        },
        "MetricsTrigger": {
          "TimeWindow": 30,
          "EvaluationCount": 2,
          "CoolDownInterval": 300,
          "TimeConstraints": [
            {
              "StartTime": "06:00",
              "EndTime": "23:59"
            }
          ],
          "ConditionLogicOperator": "Or",
          "Conditions": [
            {
              "MetricName": "yarn_resourcemanager_queue_PendingVCores",
              "Tags": [
                {
                  "Key": "department",
                  "Value": "IT"
                }
              ],
              "Statistics": "AVG",
              "ComparisonOperator": "LT",
              "Threshold": 12.5
            }
          ]
        },
        "CollationTimeZone": {
          "TimeZone": "Asia/Shanghai",
          "CurrentTimeOffset": "UTC+08:00"
        }
      }
    ],
    "ScalingPolicyId": "asp-asduwe23znl***",
    "Constraints": {
      "MaxCapacity": 2000,
      "MinCapacity": 0
    }
  },
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

Error codes

HTTP status code	Error code	Error message
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.