SuspendJobs-阿里云帮助中心

You can pause the job.

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:SuspendJobs

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	Instance ID	ef4c09ac-2f5c-49e7-9d33-5d85249cee10
All	boolean	Yes	Filter condition: whether to suspend all jobs.	false
ScenarioId	string	No	Filter condition, scenario ID (historical parameter, deprecated).	4b6dd926-3cc3-4111-a333-15d9b006fe81
JobGroupId	string	No	Filter condition, task group ID.	6b3ea2a1-32b3-4041-842b-9bde5de9dda0
JobId	array	No	Job ID list. Note When ALL is false, JobId is required.	11994321-e6bc-47bb-8b1c-8eef8f2f768b
	string	No	Job ID.	11994321-e6bc-47bb-8b1c-8eef8f2f768b
JobReferenceId	array	No	Third-party ID of the job. Note This is the ReferenceId uploaded by the customer when uploading the outbound list.	de3ab269-6746-477c-b13d-bd49f13202c2
	string	No	Third-party ID of the job.	de3ab269-6746-477c-b13d-bd49f13202c2

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code.	200
Code	string	API status code.	OK
Message	string	API message.	Success
RequestId	string	Request ID.	1364f208-982d-4d0c-89aa-d56e22b47589
Success	boolean	Whether successful.	true

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "1364f208-982d-4d0c-89aa-d56e22b47589",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
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.
404	NotExist.JobGroup	The specified JobGroup does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.