All Products
Search

This Product

    Elastic High Performance Computing:UpdateCluster

    Document Center

    Elastic High Performance Computing:UpdateCluster

    Last Updated:Aug 28, 2026

    Modify the basic information of a specified cluster.

    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

    ehpc:UpdateCluster

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ClusterId

    string

    No

    The client version. By default, the latest version is used.

    ehpc-hz-FYUr32****
    ClusterName

    string

    No

    The post-processing script of the cluster.

    slurm22.05.8-serverless-cluster-20240805
    ClusterDescription

    string

    No

    The URL to download the post-processing script.

    slurm22.05.8-serverless-cluster-20240805

    MaxCount

    integer

    No

    The arguments to run the post-processing script.

    500
    MaxCoreCount

    integer

    No

    The interval at which the cluster is automatically scaled out.

    10000
    DeletionProtection

    boolean

    No

    The idle duration of the compute nodes allowed by the cluster.

    false
    ClientVersion

    string

    No

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

    • true

    • false

    2.1.0
    ClusterCustomConfiguration

    object

    No

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

    • true

    • false

    Script

    string

    No

    The monitoring details of the cluster.

    http://*****

    Args

    string

    No

    Specifies whether to enable the monitoring component of compute nodes. Valid values:

    • true

    • false

    E-HPC cn-hangzhou

    GrowInterval

    integer

    No

    The scheduler specifications of the cluster.

    2
    IdleInterval

    integer

    No

    Specifies whether to enable the topology awareness feature. Valid values:

    • true

    • false

    4
    EnableScaleOut

    boolean

    No

    The response parameters.

    true
    EnableScaleIn

    boolean

    No

    The request result. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true
    MonitorSpec

    object

    No

    The monitoring details of the cluster.

    EnableComputeLoadMonitor

    boolean

    No

    Specifies whether to enable the monitoring component of compute nodes. Valid values:

    • true

    • false

    true
    SchedulerSpec

    object

    No

    The scheduler specifications of the cluster.

    EnableTopologyAwareness

    boolean

    No

    Specifies whether to enable the topology awareness feature. Valid values:

    • true

    • false

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    Success

    boolean

    The request result. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true
    RequestId

    string

    The request ID.

    04F0F334-1335-436C-A1D7-6C044FE7****

    Examples

    Success response

    JSON format

    {
  "Success": true,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParams The specified parameter %s is invalid. The specified parameter %s is invalid.
    500 UnknownError An unknown error occurred. An unknown error occurred.
    406 DbError A database service error occurred. Database request failed.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.