All Products
Search
Document Center

Elastic High Performance Computing:DeleteUsers

Last Updated:Apr 09, 2024

Deletes users from a cluster.

Operation description

If you delete a user, only its information is deleted. The files stored in the /home directory for the user are retained. For example, if you delete a user named user1, the files in the /home/user1/ directory of the cluster are not deleted. However, a deleted user cannot be recovered. Even if you create another user that has the same name, the data retained for the deleted user is not reused.

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
ehpc:DeleteUsersWRITE
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

You can call the ListClusters operation to obtain the cluster ID.

ehpc-hz-FYUr32****
Userobject []Yes

The information about the user.

NamestringYes

The name of the user N that you want to delete. Valid values of N: 1 to 100.

You can call the ListUsers operation to query the users of the cluster.

user1
AsyncbooleanNo

Specifies whether to enable the asynchronous mode for this request.

Default value: false.

false

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE****

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
403InvalidClusterStatusThe operation failed due to invalid cluster status.The cluster status does not support the operation.
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
404ManagerNotFoundThe manager nodes do not exist or their status is abnormal.The manager nodes do not exist or their status is abnormal.
406AgentErrorThe agent service request failed.-
406AgentError.Account.DomainNotExistThe specified domain does not exist: %s.The domain service does not exist: %s
406AgentError.Account.GetentPasswdFailureFailed to get the user list: %s.Failed to obtain the domain user list: %s
406AgentError.Account.UserNotExistThe specified user is not found in the domain: %s.The user does not exist in the domain: %s.
406AgentError.Account.UserDeleteFailureFailed to delete user from domain: %s.Failed to remove the user from domain: %s
406AgentResponseTimeoutAgent response timeout: %s-
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
409PartFailurePart of the batch operation failed.Part of the batch operation failed.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

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