You can call this operation to modify the description of an Alibaba Cloud HPC (HPC) cluster.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:ModifyHpcClusterAttribute | update | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the HPC cluster. You can call the DescribeRegions operation 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 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 |
| RegionId | string | Yes | The region ID of the HPC cluster. You can call the DescribeRegions operation 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://. This parameter is empty by default. | 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 but cannot start with http:// or https://. It can contain letters, digits, underscores (_), and hyphens (-). This parameter is empty by default. | testName |
Response parameters
Examples
Sample success responses
JSONformat
{
"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 | Parameters are invalid. You must specify at least one of the Name and Description parameters. |
| 400 | HPC_CLUSTER_MODIFY_FAILED | Modify failed, possibly this hpc cluster does not exist | The HPC cluster cannot be modified. Check whether the cluster exists. |
| 400 | Invalid.Parameter | Invalid parameters | Invalid parameters. |
| 400 | HpcClusterNotExists | The specified hpc cluster does not exist | The specified HPC cluster does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-08-31 | The Error code has changed | View Change Details |