Canceling a Scheduled Task
Function
This API is used to cancel a scheduled task. Before calling this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
URI
DELETE /v3/{project_id}/scheduled-jobs
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. If the following response body is returned for calling the API used to obtain a user token, the request is successful. After the request is processed, the value of X-Subject-Token in the message header is the token value. |
|
X-Language |
No |
String |
Request language type. The default value is en-us. Value:
|
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
job_ids |
Yes |
Array of strings |
Task ID. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
job_ids |
Array of strings |
Task ID for canceling a scheduled task. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Request
Canceling a scheduled task
DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/scheduled-jobs
{
"job_ids" : [ "56d3c1138dcf4f1da73b0170700c78d0" ]
}
Example Response
Status code: 200
Success.
{
"job_ids" : [ "56d3c1138dcf4f1da73b0170700c78d0" ]
}
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
