All Products
Search
Document Center

E-MapReduce:GetAutoScalingPolicy

Last Updated:Oct 28, 2024

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
emr:GetAutoScalingPolicyget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

c-b933c5aac8fe****
NodeGroupIdstringYes

The ID of the node group.

ng-869471354ecd****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ScalingPolicyobject

The information about the auto scaling policy.

NodeGroupIdstring

The ID of the node group.

ng-869471354ecd****
ClusterIdstring

The cluster ID.

c-b933c5aac8fe****
ScalingRulesarray<object>

The auto scaling rules.

ScalingRuleDTOobject
RuleNamestring

The name of the auto scaling rule.

scaling-out-memory
TriggerTypestring

The type of the auto scaling rule. Valid values:

  • TIME_TRIGGER: time-based scaling
  • METRICS_TRIGGER: load-based scaling
TIME_TRIGGER
ActivityTypestring

The scaling type. Valid values:

  • SCALE_OUT
  • SCALE_IN
SCALE_OUT
AdjustmentTypestring

The adjustment type.

CHANGE_IN_CAPACITY
AdjustmentValueinteger

The adjustment value. The parameter value must be a positive integer, which indicates the number of instances that you want to add or remove.

100
TimeTriggerTimeTrigger

The description of time-based scaling.

MetricsTriggerMetricsTrigger

The description of load-based scaling.

ScalingPolicyIdstring

The ID of the scaling policy.

asp-asduwe23znl***
Constraintsobject

The maximum and minimum number of nodes in the node group.

MaxCapacityinteger

The maximum number of nodes in the node group. Default value: 2000.

2000
MinCapacityinteger

The minimum number of nodes in the node group. Default value: 0.

0
RequestIdstring

The request ID.

DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Sample success responses

JSONformat

{
  "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": "",
          "StartTime": 1639714800000,
          "EndTime": 1639714800000,
          "LaunchExpirationTime": 600,
          "RecurrenceType": "WEEKLY",
          "RecurrenceValue": "MON,FRI,SUN"
        },
        "MetricsTrigger": {
          "TimeWindow": 30,
          "EvaluationCount": 2,
          "CoolDownInterval": 300,
          "TimeConstraints": [
            {
              "StartTime": "06:00:00",
              "EndTime": "23:59:59"
            }
          ],
          "ConditionLogicOperator": "Or",
          "Conditions": [
            {
              "MetricName": "yarn_resourcemanager_root_availablememoryusage",
              "Tags": [
                {
                  "Key": "department",
                  "Value": "IT"
                }
              ],
              "Statistics": "AVG",
              "ComparisonOperator": "LT",
              "Threshold": 12.5
            }
          ]
        }
      }
    ],
    "ScalingPolicyId": "asp-asduwe23znl***",
    "Constraints": {
      "MaxCapacity": 2000,
      "MinCapacity": 0
    }
  },
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

Error codes

HTTP status codeError codeError message
400ConflictParametersParameters that must not be used together. %s
400IncompleteSignatureThe request signature is invalid.
400InvalidActionThe action %s requested is invalid.
400InvalidParameterThe specified parameter %s is not valid.
400InvalidParameterValueThe input parameter %s is invalid or out of range.
400MissingActionThe action %s requested is missing.
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.
400NotAuthorizedYou do not have permission to perform this action. %s
400ThrottlingExceptionThe request was denied due to request throttling. %s
404ResourceNotFoundThe resource not found by %s.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.
503ServiceFailureThe request has failed due to a temporary failure of %s service.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-06-18The response structure of the API has changedView Change Details
2024-03-15The response structure of the API has changedView Change Details