All Products
Search
Document Center

Elastic High Performance Computing:StopCluster

Last Updated:Apr 16, 2024

Stops a cluster.

Operation description

If you stop a subscription compute node, its billing is not affected. If you stop a pay-as-you-go compute node for which you have enabled the economical mode, you are no longer charged for its computing resources. For more information, see Economical mode.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

You can call the ListClusters operation to query the list of clusters in a region.

ehpc-hz-FYUr32****

Response parameters

ParameterTypeDescriptionExample
object
TaskIdstring

The task ID.

04F0F334-1335-436C-A1D7-6C044FE7****
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

{
  "TaskId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****"
}

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.
403ConflictOptA conflicting operation is running.A conflicting operation is running. Please try again later.
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
406EcsErrorAn error occurred while calling the ECS API operation.An error occurred while calling the ECS API operation.
406DbErrorA database service error occurred.Database request failed.
406AliyunErrorAn Alibaba Cloud product error occurred.An Alibaba Cloud product error occurred.
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
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.