Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.pipelineJobs.batchCancel
Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.
Endpoint
post
https://{service-endpoint}/v1/{parent}/pipelineJobs:batchCancel
Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}
Request body
The request body contains data with the following structure:
Fields
names[]
string
Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}
Response body
If successful, the response body contains an instance of Operation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: pipelineJobs.batchCancel\n\n**Full name**: projects.locations.pipelineJobs.batchCancel\n\nBatch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. \n\n### Endpoint\n\npost `https:``/``/{service-endpoint}``/v1``/{parent}``/pipelineJobs:batchCancel` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`parent` `string` \nRequired. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`\n\n### Request body\n\nThe request body contains data with the following structure:\nFields `names[]` `string` \nRequired. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}` \n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/vertex-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation)."]]
