Call ModifyHpcClusterAttribute to change the name and description of an HPC cluster - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

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

ecs:ModifyHpcClusterAttribute

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
HpcClusterId	string	Yes	The ID of the HPC cluster.	hpc-b8bq705cvx1****
Description	string	No	The description of the HPC cluster. The description must be 2 to 256 characters in length and cannot start with http:// or https://. Default value: empty.	testDescription
Name	string	No	The name of the HPC cluster. The name must be 2 to 128 characters in length. It must start with a letter or a Chinese character and cannot start with http:// or https://. It can contain digits, underscores (_), or hyphens (-). Default value: empty.	testName

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter RegionId that is mandatory for processing this request is not supplied.
400	InvalidHpcClusterName.Malformed	Specified hpc cluster name is not valid.	The specified HPC cluster name is invalid.
400	InvalidHpcClusterDescription.Malformed	The specified parameter Description is not valid.	The specified HPC cluster description is invalid.
400	InvalidRegionId.NotFound	The specified parameter "RegionId" is not valid.
400	InvalidModifyInfo	Modify info is invalid, name/description must not null at the same time.
400	HPC_CLUSTER_MODIFY_FAILED	Modify failed, possibly this hpc cluster does not exist.
400	Invalid.Parameter	Invalid parameters.	Invalid parameters.
400	HpcClusterNotExists	The specified hpc cluster does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.