Cancelar execuções de pipeline

Se você não precisar mais de uma execução de pipeline programada ou em execução, poderá cancelá-la. Se houver várias execuções de pipeline para cancelar, você poderá cancelar em lote essas execuções.

Quando você inicia um cancelamento de execução de pipeline, o status da execução do pipeline muda para Cancelando. Durante esse status, os pipelines da Gemini Enterprise Agent Platform cancelam todas as tarefas restantes no pipeline e todos os Cloud de Confiance by S3NS serviços e recursos invocados pela execução do pipeline. Depois que todas essas tarefas, serviços e recursos forem cancelados, o status do pipeline mudará para Cancelado.

Uma execução de pipeline cancelada não é excluída. Você tem a opção de excluir a execução do pipeline depois de cancelá-la.

Cancelar uma execução de pipeline

Para cancelar uma execução de pipeline, use o Cloud de Confiance console, a API REST ou o SDK da Agent Platform para Python.

Console

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

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

    Acessar "Execuções"

  2. Na coluna Execução, 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, Cloud de Confiance by S3NS serviços e Cloud de Confiance by S3NS recursos 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 os pipelines da Agent Platform estão disponíveis, consulte o Guia de locais da Gemini Enterprise Agent Platform.
  • PROJECT_ID: O Cloud de Confiance by S3NS projeto que contém a execução do pipeline.
  • PIPELINE_RUN_ID: o ID exclusivo da execução do pipeline que você quer cancelar. O ID da execução do pipeline é mostrado na guia Execuções na página Pipelines no Cloud de Confiance console.

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 Cloud de Confiance by S3NS 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 os pipelines da Agent Platform estão disponíveis, consulte o Guia de locais da Gemini Enterprise Agent Platform.
  • PIPELINE_RUN_ID com o ID exclusivo da execução do pipeline que você quer cancelar. O ID é mostrado na guia Execuções na página Pipelines no Cloud de Confiance console.

Cancelar várias execuções de pipeline

Para cancelar várias execuções de pipeline simultaneamente, use a API REST ou o SDK da Agent Platform para Python. É possível cancelar em lote as 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 os pipelines da Agent Platform estão disponíveis, consulte o Guia de locais da Gemini Enterprise Agent Platform.
  • PROJECT_ID: O Cloud de Confiance by S3NS projeto que contém as execuções de pipeline.
  • PIPELINE_RUN_ID_1, PIPELINE_RUN_ID_2: os IDs dos jobs de pipeline que você quer cancelar. É possível encontrar o ID do job na guia Execuções na página Pipelines no Cloud de Confiance console.

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. É possível localizar esse número do projeto no Cloud de Confiance 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 do pipeline são mostrados na guia Execuções na página Pipelines no Cloud de Confiance console.