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.
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:
- For mandatory resource types, indicate with a prefix of * .
- 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ehpc:ModifyClusterAttributes | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|
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:
| 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.
| 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 parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE7336"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|
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. | - |
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. |
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. |
500 | UnknownError | An unknown error occurred. | An unknown error occurred. |
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. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|
Change time | Summary of changes | Operation |
---|---|---|
2023-03-21 | The Error code has changed. The request parameters of the API has changed | View Change Details |