All Products
Search

This Product

    E-MapReduce:UpdateClusterAutoRenew

    Document Center

    E-MapReduce:UpdateClusterAutoRenew

    Last Updated:Oct 22, 2025

    Enables or disables auto-renewal for an EMR cluster and its Elastic Compute Service (ECS) instances.

    Operation description

    Before you call this operation, make sure you understand the billing methods and pricing of E-MapReduce. Note: Auto-renewal is different from manual renewal. If an instance has expired or will expire the next day, you must perform a manual renewal first.

    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:UpdateClusterAutoRenew

    update

    *All Resource

    *

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    RegionId

    string

    Yes

    The region ID.

    cn-hangzhou

    ClusterId

    string

    Yes

    The cluster ID.

    c-d6661c71139a****

    ClusterAutoRenew

    boolean

    No

    Specifies whether to enable auto-renewal for the cluster. Valid values:

    • true: Enables auto-renewal.

    • false: Disables auto-renewal.

    Default value: false.

    true

    ClusterAutoRenewDuration

    integer

    No

    The auto-renewal duration for the cluster. This parameter takes effect only when ClusterAutoRenew is set to true. If ClusterAutoRenewDurationUnit is set to Month, the valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36. If ClusterAutoRenewDurationUnit is set to Year, the valid values are 1, 2, and 3.

    1

    ClusterAutoRenewDurationUnit

    string

    No

    The unit of the auto-renewal duration. Valid values:

    • Month

    • Year

    Default value: Month.

    Monthly

    RenewAllInstances

    boolean

    No

    Specifies whether to enable auto-renewal for all ECS instances in the cluster. Valid values:

    • true: Enables auto-renewal for all ECS instances in the cluster. The default auto-renewal duration is one month.

    • false: Does not enable auto-renewal for all ECS instances in the cluster. You can specify the ECS instances for which to enable auto-renewal in the AutoRenewInstances parameter.

    Default value: false.

    AutoRenewInstances

    array

    No

    The list of ECS instances for which to enable auto-renewal. This parameter takes effect only when RenewAllInstances is not set to true.

    AutoRenewInstance

    No

    An ECS instance for which to enable auto-renewal.

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned data.

    Successdeprecated

    boolean

    Indicates whether the operation was successful.

    true

    RequestId

    string

    The request ID.

    9E3A7161-EB7B-172B-8D18-FFB06BA3896A

    Examples

    Success response

    JSON format

    {
  "Success": true,
  "RequestId": "9E3A7161-EB7B-172B-8D18-FFB06BA3896A"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    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.