CancelJobs-阿里云帮助中心

Cancels jobs that are pending or in progress. This operation cannot cancel jobs that are already in a call.

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

outboundbot:CancelJobs

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	174952ab-9825-4cc9-a5e2-de82d7fa4cdd
All	boolean	Yes	Specifies whether to cancel all jobs.	false
ScenarioId	string	No	A filter condition. The scenario ID. Note Obtain this ID by calling the DescribeJobGroup operation.	35641113-b2f6-464e-a772-25c25554798b
JobGroupId	string	No	A filter condition. The task group ID.	9f84892d-721a-4069-9975-668c8164d64e
JobId	array	No	A filter condition. The job ID. Note The JobId parameter is required when the All parameter is set to false.	edf45790-7200-4cbc-b157-8c0a5f400b75
	string	No	The ID of the job to cancel.	edf45790-7200-4cbc-b157-8c0a5f400b75
JobReferenceId	array	No	A filter condition. The reference ID of the job. Note This is the ReferenceId that you specified when you uploaded the contact list.	4a875676-b136-4087-88b4-de67c61fed69
	string	No	The third-party ID of the job.	C01

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The response code.	OK
Message	string	The response message.	Success
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request was successful.	true

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404	NotExist.Instance	The specified Instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.