All Products
Search
Document Center

Elastic Compute Service:ModifyHpcClusterAttribute

Last Updated:Sep 29, 2024

You can call this operation to modify the description of an Alibaba Cloud HPC (HPC) cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:ModifyHpcClusterAttributeupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the HPC cluster. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The ClientToken value must contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotency.

123e4567-e89b-12d3-a456-426655440000
RegionIdstringYes

The region ID of the HPC cluster. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
HpcClusterIdstringYes

The ID of the HPC cluster.

hpc-b8bq705cvx1****
DescriptionstringNo

The description of the HPC cluster. The description must be 2 to 256 characters in length and cannot start with http:// or https://.

This parameter is empty by default.

testDescription
NamestringNo

The name of the HPC cluster. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, underscores (_), and hyphens (-).

This parameter is empty by default.

testName

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter RegionId that is mandatory for processing this request is not supplied.-
400InvalidHpcClusterName.MalformedSpecified hpc cluster name is not valid.The specified HPC cluster name is invalid.
400InvalidHpcClusterDescription.MalformedThe specified parameter Description is not valid.The specified HPC cluster description is invalid.
400InvalidRegionId.NotFoundThe specified parameter "RegionId" is not valid.-
400InvalidModifyInfoModify info is invalid, name/description must not null at the same timeParameters are invalid. You must specify at least one of the Name and Description parameters.
400HPC_CLUSTER_MODIFY_FAILEDModify failed, possibly this hpc cluster does not existThe HPC cluster cannot be modified. Check whether the cluster exists.
400Invalid.ParameterInvalid parametersInvalid parameters.
400HpcClusterNotExistsThe specified hpc cluster does not existThe specified HPC cluster does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-31The Error code has changedView Change Details