All Products
Search
Document Center

Elastic High Performance Computing:ModifyClusterAttributes

Last Updated:Oct 26, 2026

Modifies the basic information of a specified cluster, including the cluster name, cluster description, and cluster image.

Operation description

Operation description

Before modifying the basic information of a cluster, call DescribeCluster to query the details of the 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:ModifyClusterAttributes

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

ClusterId

string

Yes

The ID of the cluster that you want to modify.

ehpc-hz-FYUr32****

Name

string

No

The new name of the cluster.

cluster1

Description

string

No

The new description of the cluster.

test-description

ImageOwnerAlias

string

No

The type of the new image for the cluster. Valid values:

  • system: public image

  • self: custom image

  • others: shared image

  • marketplace: Alibaba Cloud Marketplace image

self

ImageId

string

No

The image ID.

centos_7_06_64_20G_alibase_2019071****

RamRoleName

string

No

The name of the instance RAM role when you configure instance authorization.

testRamRoleName

RamNodeTypes

array

No

The node types to which the RAM role is bound when you configure instance authorization.

string

No

The node types to which the RAM role is bound when you configure instance authorization.

  • If DeployMode is set to Standard, valid values: scheduler, account, login, and compute. Multiple values are supported. Separate multiple values with commas (,).

  • If DeployMode is set to Simple, valid values: manager, login, and compute. Multiple values are supported. Separate multiple values with commas (,).

  • If DeployMode is set to Tiny, valid values: manager and compute.

manager,compute

WinAdPar

object

No

The connection parameters for Windows AD.

AdUser

string

No

The administrator of the Windows AD server.

administrator

AdUserPasswd

string

No

The password of the Windows AD server administrator.

xxxxxxx

AdDc

string

No

The domain name of the Windows AD server.

ehpcad.com

AdIp

string

No

The IP address of the Windows AD server.

192.168.1.2

FallbackHomeDir

string

No

The home directory on the Linux server.

/home

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

04F0F334-1335-436C-A1D7-6C044FE7336

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7336"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParams The specified parameter %s is invalid. The specified parameter %s is invalid.
400 NotEnabled You have not enabled this service You have not enabled this service
400 InDebt Your account has overdue payments. Your account has overdue payments.
400 InvalidImage The image ID is invalid. The image ID is invalid.
400 ImageNotMatched The image is not matched. The image does not match.
500 UnknownError An unknown error occurred. An unknown error occurred.
404 ClusterNotFound The specified cluster does not exist. The specified instance does not exist.
404 ManagerNotFound The manager nodes do not exist or their status is abnormal. The manager nodes do not exist or their status is abnormal.
503 ServiceUnavailable The request has failed due to a temporary failure of the server The request has failed due to a temporary failure of the server.
406 DbError A database service error occurred. Database request failed.
407 NotAuthorized You are not authorized by RAM for this request. The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.