Stop jobs in a cluster using StopJobs - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Stops one or more jobs in a cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:StopJobs

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-FYUr32****
Jobs	string	Yes	The jobs to stop. You can specify 1 to 100 jobs. Format: `[{"Id": "0.sched**"},{"Id": "1.sched"}]`. Separate multiple jobs with commas (,). You can call the ListJobs operation to query the job ID. Note** You can stop only jobs that are in the RUNNING or QUEUED state.	[{"Id":"1.sched**"},{"Id":"0.sched**"}]
Async	boolean	No	Whether to stop the job asynchronously. Default value: false	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
403	ConflictOpt	A conflicting operation is running.	A conflicting operation is running. Please try again later.
403	UsernameExist	The username already exists.	The username already exists.
403	IncorrectCredential	The username or password is incorrect.	The username or password is incorrect.
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.
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.
406	AgentError.Job.StopFailure	Failed to stop jobs: %s.	Failed to stop the job: %s
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
406	AgentResponseTimeout	Agent response timeout: %s
406	AgentError	The agent service request failed: %s	Operation unsuccessful: %s
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.
409	PartFailure	Part of the batch operation failed.	Part of the batch operation failed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.