Cancelar execuções de pipeline

Se você não precisar mais de uma execução de pipeline programada ou em andamento, cancele-a. Se houver várias execuções de pipeline para cancelar, faça isso em lote.

Quando você inicia o cancelamento de uma execução de pipeline, o status dela muda para Cancelando. Durante esse status, o Vertex AI Pipelines cancela todas as tarefas restantes no pipeline e todos os serviços e recursos do Google Cloud invocados pela execução do pipeline. Depois que todas essas tarefas, serviços e recursos forem cancelados, o status do pipeline vai mudar para Cancelado.

Uma execução de pipeline cancelada não é excluída. Você pode excluir a execução do pipeline depois de cancelar.

Cancelar uma execução de pipeline

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

Console

Use as instruções a seguir para cancelar uma execução de pipeline em andamento no console Google Cloud :

  1. Na seção "Vertex AI", acesse a guia Execuções na página Pipelines.

    Acessar "Execuções"

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

Depois de clicar em Parar, o status do pipeline muda para Cancelando. Depois que todas as tarefas do pipeline, os serviços Google Cloud e os recursosGoogle Cloud invocados pela execução forem cancelados, o status mudará para Cancelado.

REST

Para cancelar uma execução de pipeline em andamento ou programada, envie uma solicitação POST usando o método pipelineJobs.cancel.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • LOCATION: a região em que a execução do pipeline está localizada. Para mais informações sobre as regiões em que a Vertex AI Pipelines está disponível, consulte o Guia de locais 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 de pipeline que você quer cancelar. O ID da execução do pipeline é exibido na guia Execuções da página Pipelines no console do Google Cloud .

Método HTTP e URL: 

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

Para enviar a solicitação, 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

Você receberá um código de status bem-sucedido (2xx) e uma resposta vazia.

Python

Use o exemplo a seguir para cancelar uma execução de pipeline em andamento ou programada usando o 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:

  • PROJECT_ID: o Google Cloud projeto que contém a execução do pipeline.
  • LOCATION: a região em que a execução do pipeline está localizada. Para mais informações sobre as regiões em que a Vertex AI Pipelines está disponível, consulte o Guia de locais da Vertex AI.
  • PIPELINE_RUN_ID com o ID exclusivo da execução do pipeline que você quer cancelar. O ID é exibido na guia Execuções da página Pipelines no consoleGoogle Cloud .

Cancelar várias execuções de pipeline

Para cancelar várias execuções de pipeline simultaneamente, use a API REST ou o SDK da Vertex AI para Python. É possível cancelar em lote execuções de pipeline que estão no mesmo projeto e região.

REST

Para cancelar em lote várias execuções de pipeline em andamento ou programadas, envie uma solicitação POST usando o método pipelineJobs.batchCancel.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • LOCATION: a região em que as execuções de pipeline estão localizadas. Para mais informações sobre as regiões em que a Vertex AI Pipelines está disponível, consulte o Guia de locais da Vertex AI.
  • PROJECT_ID: o Google Cloud projeto que contém as execuções de pipeline.
  • PIPELINE_RUN_ID_1, PIPELINE_RUN_ID_2: os IDs dos jobs do pipeline que você quer cancelar. É possível encontrar o ID do job na guia Execuções da página Pipelines no console Google Cloud .

Método HTTP e URL: 

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

Corpo JSON da solicitação:

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

Para enviar a solicitação, escolha uma destas opções:

curl

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir: 

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

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir: 

$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

Você receberá uma resposta JSON semelhante a esta:

{
  "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 exemplo a seguir para cancelar várias execuções de pipeline em andamento ou programadas usando o 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:

  • PROJECT_ID: o ID do projeto.
  • LOCATION: a região em que as execuções de pipeline foram criadas.
  • PROJECT_NUMBER: o número do projeto. Você pode localizar esse número de projeto no Google Cloud console.Para mais informações, consulte Encontrar 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 você quer cancelar. Os IDs de execução de pipeline são mostrados na guia Execuções da página Pipelines no console do Google Cloud .