Cancele execuções de pipelines

Se já não precisar de uma execução de pipeline agendada ou em execução, pode cancelá-la. Se existirem várias execuções de pipelines para cancelar, pode cancelá-las em lote.

Quando inicia o cancelamento de uma execução da pipeline, o estado da execução da pipeline muda para A cancelar. Durante este estado, o Vertex AI Pipelines cancela todas as tarefas restantes no pipeline e todos os serviços e recursos invocados pela execução do pipeline. Google Cloud Depois de todas estas tarefas, serviços e recursos serem cancelados, o estado do pipeline muda para Cancelado.

Tenha em atenção que uma execução de pipeline cancelada não é eliminada. Tem a opção de eliminar a execução do pipeline depois de a cancelar.

Cancele a execução de um pipeline

Para cancelar uma execução de pipeline, use a Google Cloud consola, a API REST ou o SDK Vertex AI para Python.

Consola

Use as instruções seguintes para cancelar uma execução de pipeline em curso a partir da Google Cloud consola:

  1. Na secção Vertex AI, aceda ao separador Execuções na página Pipelines.

    Aceda a Execuções

  2. Na coluna Executar, clique no nome da execução da pipeline que quer cancelar.
  3. Na página que apresenta os detalhes da execução do pipeline, clique em Parar. Esta opção só está disponível se a execução da pipeline estiver no estado Em execução.

Depois de clicar em Parar, o estado do pipeline muda para A cancelar. Depois de todas as tarefas, Google Cloud serviços e Google Cloud recursos do pipeline invocados pela execução serem cancelados, o estado muda para Cancelado.

REST

Para cancelar uma execução de pipeline em curso ou agendada, envie um pedido POST através do método pipelineJobs.cancel.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

  • LOCATION: a região onde a execução do pipeline está localizada. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
  • PROJECT_ID: o Google Cloud projeto que contém a execução do pipeline.
  • PIPELINE_RUN_ID: o ID exclusivo da execução do pipeline que quer cancelar. O ID da execução da pipeline é apresentado no separador Execuções na página Pipelines na Google Cloud consola.

Método HTTP e URL: 

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs/PIPELINE_RUN_ID:cancel

Para enviar o seu pedido, escolha uma destas opções:

curl

Execute o seguinte comando: 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs/PIPELINE_RUN_ID:cancel"

PowerShell

Execute o seguinte comando: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs/PIPELINE_RUN_ID:cancel" | Select-Object -Expand Content

Deve receber um código de estado de êxito (2xx) e uma resposta vazia.

Python

Use o seguinte exemplo para cancelar uma execução de pipeline em curso ou agendada através do método PipelineJob.cancel:

from google.cloud import aiplatform
aiplatform.init(project=PROJECT_ID, location=LOCATION)
pipeline_job = aiplatform.PipelineJob.get(resource_name="PIPELINE_RUN_ID")
pipeline_job.cancel()

Substitua o seguinte:

  • PROJECT_ID: o Google Cloud projeto que contém a execução do pipeline.
  • LOCATION: a região onde a execução do pipeline está localizada. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
  • PIPELINE_RUN_ID com o ID exclusivo da execução do pipeline que quer cancelar. O ID é apresentado no separador Execuções na página Pipelines na Google Cloud consola.

Cancele várias execuções de pipelines

Para cancelar várias execuções de pipelines em simultâneo, use a API REST ou o SDK do Vertex AI para Python. Pode cancelar em lote execuções de pipelines que estejam no mesmo projeto e região.

REST

Para cancelar em lote várias execuções de pipelines em curso ou agendadas, envie um pedido POST através do método pipelineJobs.batchCancel.

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

  • LOCATION: a região onde as execuções do pipeline estão localizadas. Para mais informações acerca das regiões onde o Vertex AI Pipelines está disponível, consulte o guia de localizações da Vertex AI.
  • PROJECT_ID: o Google Cloud projeto que contém as execuções do pipeline.
  • PIPELINE_RUN_ID_1, PIPELINE_RUN_ID_2: os IDs das tarefas da pipeline que quer cancelar. Pode encontrar o ID da tarefa no separador Execuções da página Pipelines na Google Cloud consola.

Método HTTP e URL: 

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs:batchCancel

Corpo JSON do pedido: 

{
  "names": [
    "projects/PROJECT_ID/locations/LOCATION/pipelineJobs/PIPELINE_RUN_ID_1",
    "projects/PROJECT_ID/locations/LOCATION/pipelineJobs/PIPELINE_RUN_ID_2"
  ]
}

Para enviar o seu pedido, escolha uma destas opções:

curl

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando: 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs:batchCancel"

PowerShell

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs:batchCancel" | Select-Object -Expand Content

Deve receber uma resposta JSON semelhante à seguinte:

{
  "name": "projects/PROJECT_NUMBER/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.aiplatform.v1.BatchCancelPipelineJobsOperationMetadata",
    "genericMetadata": {
      "createTime": "2025-05-25T16:11:21.011113Z",
      "updateTime": "2025-05-25T16:11:21.011113Z"
    }
  }
}

Python

Use o seguinte exemplo para cancelar várias execuções de pipelines em curso ou agendadas através do método PipelineJob.batch_cancel:

from google.cloud import aiplatform_v1
from google.api_core.client_options import ClientOptions
pipeline_run_ids_to_cancel = [
  "PIPELINE_RUN_ID_1",
  "PIPELINE_RUN_ID_2",
]
client_options = ClientOptions(api_endpoint=f"LOCATION-aiplatform.googleapis.com")
pipeline_job_client = aiplatform_v1.PipelineServiceClient(client_options=client_options)
pipeline_resource_names_to_cancel = []
for run_id in pipeline_run_ids_to_cancel:
  full_resource_name = f"projects/PROJECT_NUMBER/locations/LOCATION/pipelineJobs/{run_id.strip()}"
  pipeline_resource_names_to_cancel.append(full_resource_name)
parent = f"projects/PROJECT_ID/locations/LOCATION"
pipeline_job_client.batch_cancel_pipeline_jobs(parent=parent, names=pipeline_resource_names_to_cancel)

Substitua o seguinte:

  • PROJECT_ID: o ID do seu projeto.
  • LOCATION: a região onde as execuções do pipeline foram criadas.
  • PROJECT_NUMBER: o número do projeto. Pode localizar este número do projeto na Google Cloud consola.Para mais informações, consulte o artigo Encontre o nome, o número e o ID do projeto.
  • PIPELINE_RUN_ID_1 e PIPELINE_JOB_ID_2: os IDs exclusivos das execuções de pipeline que quer cancelar. Os IDs de execução do pipeline são apresentados no separador Execuções na página Pipelines na Google Cloud consola.