Update cluster attributes with ModifyClusterAttributes - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

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

Operation description

Usage notes

Before you call this operation, you can call the DescribeCluster operation to query details of the selected 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

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 cluster name.	cluster1
Description	string	No	The new cluster description.	test-description
ImageOwnerAlias	string	No	The new image type of the cluster. Valid values: system: public image self: custom image others: shared image marketplace: Alibaba Cloud Marketplace image	self
ImageId	string	No	The IDs of the images.	centos_7_06_64_20G_alibase_2019071****
RamRoleName	string	No	The name of the instance RAM role.	testRamRoleName
RamNodeTypes	array	No	The type of the node to which you want to bind the RAM role.
	string	No	The type of the node to which you want to bind the RAM role. Valid values if the DeployMode parameter is set to Standard: scheduler, account, login, and compute. Separate multiple values with commas (,). Valid values if the DeployMode parameter is set to Simple: manager, login, and compute. Separate multiple values with commas (,). Valid values if the DeployMode parameter is set to Tiny: manager and compute.	manager,compute
WinAdPar	object	No	The parameters that are used to connect to the Windows AD server.
AdUser	string	No	The Windows AD server administrator.	administrator
AdUserPasswd	string	No	The administrator password of the Windows AD server.	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 of 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.
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.