Neste documento, explicamos como visualizar jobs e tarefas em lote.
Antes de começar
- Se você nunca usou o Batch, consulte Primeiros passos com o Batch e ative-o cumprindo os pré-requisitos para projetos e usuários.
-
Para receber as permissões necessárias para visualizar os jobs e tarefas, peça ao administrador para conceder a você o papel de Leitor de jobs em lote (
roles/batch.jobsViewer
) ou Editor de jobs em lote (roles/batch.jobsEditor
) do IAM no projeto. Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.
Ver seus jobs
Para ver os jobs, selecione um dos seguintes métodos:
Para ver todos os jobs do projeto, acesse a lista de jobs.
Para ver todos os detalhes de configuração de um job específico, confira os detalhes de um job.
Ver uma lista dos jobs
É possível ver uma lista de jobs do projeto atual usando o console do Google Cloud, a CLI gcloud, a API Batch, Go, Java, Node.js, Python ou C++.
Se você quiser filtrar uma lista de jobs (por exemplo, para listar apenas jobs em um local específico ou com um ou mais rótulos específicos), use a CLI gcloud ou a API Batch.
Console
Para ver uma lista de jobs do projeto atual usando o console do Google Cloud, acesse a página Lista de jobs.
gcloud
Para ver uma lista de jobs no projeto atual usando a
CLI gcloud, use o
comando gcloud batch jobs list
.
gcloud batch jobs list
Também é possível adicionar uma ou mais sinalizações para ver uma lista filtrada de tarefas:
Para ver apenas os jobs em um local específico, inclua a sinalização
--location
.Para visualizar somente jobs com base em uma expressão de filtro, especifique a sinalização
--filter
.
Por exemplo, use o seguinte comando:
gcloud batch jobs list \
--location=LOCATION \
--filter="FILTER_EXPRESSION"
Substitua:
LOCATION
: o local em que há um ou mais jobs.FILTER_EXPRESSION
: uma expressão de filtro.Por exemplo, suponha que seu projeto tenha definido os seguintes rótulos personalizados:
Para indicar jobs e recursos criados pela equipe de pesquisa ao visualizar os relatórios do Cloud Billing, alguns dos jobs e os recursos deles têm um rótulo
team
definido comoresearch
.Para indicar cargas de trabalho urgentes, alguns jobs têm um rótulo
deadline
, definido como vários valores.Para indicar os executáveis que sua equipe de desenvolvimento testou, alguns têm um rótulo
tested
definido comotrue
.
É possível especificar a expressão de filtro a seguir para visualizar apenas os jobs que atendem a todos os critérios a seguir:
Jobs da equipe de pesquisa que têm um rótulo
team
na política de alocação do job definida comoresearch
.Vagas que atendam a pelo menos um dos seguintes critérios:
Jobs urgentes que têm um rótulo
deadline
definido como qualquer valor.Jobs que têm pelo menos um executável que foi testado com sucesso, que são jobs que têm pelo menos um executável com um rótulo
tested
definido comotrue
.
(allocationPolicy.labels.team=research) AND ((labels.deadline:*) OR (runnables.labels.tested=true))
API
Para ver uma lista de jobs no projeto atual para um local específico usando a API Batch, faça uma solicitação GET
para o método jobs.list
.
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs
Substitua:
PROJECT_ID
: o ID do projeto do projeto atual.LOCATION
: o local em que os jobs estão.
Também é possível especificar o parâmetro de consulta filter
para consultar uma lista filtrada de vagas com base em uma expressão de filtro.
Por exemplo, faça a seguinte solicitação GET
:
GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?filter=FILTER_EXPRESSION
Substitua FILTER_EXPRESSION
por uma expressão de filtro que use a codificação de URL.
Por exemplo, suponha que você definiu os seguintes rótulos personalizados:
Para indicar jobs e recursos criados pela equipe de pesquisa ao visualizar os relatórios do Cloud Billing, alguns dos jobs e os respectivos recursos têm um rótulo
team
definido comoresearch
.Para indicar cargas de trabalho urgentes, alguns dos jobs têm rótulos
deadline
, definidos como vários valores.Para indicar os executáveis que sua equipe de desenvolvimento testou com êxito, os executáveis de alguns jobs têm um rótulo
tested
definido comotrue
.
É possível especificar a expressão de filtro a seguir para visualizar apenas os jobs que atendem a todos os critérios a seguir:
Jobs da equipe de pesquisa que têm um rótulo
team
na política de alocação do job definida comoresearch
.Vagas que atendam a pelo menos um dos seguintes critérios:
Jobs urgentes que têm um rótulo
deadline
definido como qualquer valor no job.Jobs que têm pelo menos um executável que foi testado com sucesso, que são jobs que têm pelo menos um executável com um rótulo
tested
definido comotrue
.
(allocationPolicy.labels.team%3Dresearch)%20AND%20((labels.deadline%3A*)%20OR%20(runnables.labels.tested%3Dtrue))
A expressão de filtro codificada para URL representa a seguinte expressão de filtro decodificado:
(allocationPolicy.labels.team=research) AND ((labels.deadline:*) OR (runnables.labels.tested=true))
Go
Go
Para mais informações, consulte a documentação de referência da API Go em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Java
Para mais informações, consulte a documentação de referência da API Java em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Node.js
Para mais informações, consulte a documentação de referência da API Node.js em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Python
Para mais informações, consulte a documentação de referência da API Python em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
C++
C++
Para mais informações, consulte a documentação de referência da API C++ em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Visualizar os detalhes de uma tarefa
É possível visualizar os detalhes de um job do projeto atual usando o console do Google Cloud, a CLI gcloud, a API Batch, Go, Java, Node.js, Python ou C++.
Se você quiser ver os rótulos especificados em um job, use a CLI gcloud ou a API Batch.
Console
Para visualizar os detalhes de um job no projeto atual usando o console do Google Cloud, siga estas etapas:
No console do Google Cloud, acesse a página Lista de jobs.
Na coluna Nome do job, clique no nome de um job.
A página Detalhes do job é aberta.
A guia Detalhes é aberta por padrão. Para mais informações, clique em outras guias.
gcloud
Para ver os detalhes de um job no projeto atual usando a
CLI gcloud, use o
comando gcloud batch jobs describe
com a sinalização --location
.
gcloud batch jobs describe JOB_NAME \
--location=LOCATION
Substitua:
JOB_NAME
: o nome de um job atual.LOCATION
: o local em que o job está.
API
Para ver os detalhes de um job no projeto atual usando a
API Batch, faça uma solicitação GET
para o
método jobs.get
.
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME
Substitua:
PROJECT_ID
: o ID do projeto atual.LOCATION
: o local em que o job está.JOB_NAME
: o nome de um job atual.
Go
Go
Para mais informações, consulte a documentação de referência da API Go em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Java
Para mais informações, consulte a documentação de referência da API Java em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Node.js
Para mais informações, consulte a documentação de referência da API Node.js em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Python
Para mais informações, consulte a documentação de referência da API Python em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
C++
C++
Para mais informações, consulte a documentação de referência da API C++ em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ver tarefas
Para ver as tarefas de um dos jobs, selecione um dos seguintes métodos:
Para encontrar todas as tarefas em um job ou em um grupo de tarefas, confira a lista de tarefas de um job.
Veja os detalhes de uma tarefa para conferir todos os detalhes de configuração de uma tarefa específica.
Ver uma lista das tarefas de uma tarefa
É possível ver uma lista das tarefas em um job ou em um grupo de tarefas usando o console do Google Cloud, a CLI gcloud, a API Batch, Go, Java, Node.js, Python ou C++.
Se você quiser filtrar uma lista de tarefas em um job ou em um grupo de tarefas, por exemplo, para listar apenas as tarefas que foram concluídas com sucesso, use a CLI gcloud ou a API Batch.
Console
Para conferir uma lista das tarefas e dos detalhes de um job usando o console do Google Cloud, confira os detalhes de um job para abrir a página Detalhes do job e consultar a seção Detalhes da tarefa.
gcloud
Para ver uma lista das tarefas no grupo de tarefas de um job usando a
CLI gcloud, use o
comando gcloud batch tasks list
com as sinalizações a seguir:
gcloud batch tasks list \
--job=JOB_NAME \
--location=LOCATION
Substitua:
JOB_NAME
: o nome de um job atual.LOCATION
: o local em que a vaga está.
Também é possível adicionar a sinalização --filter
para visualizar uma lista filtrada de tarefas
no grupo de tarefas de um job com base em uma expressão de filtro.
Por exemplo, use o seguinte comando:
gcloud batch tasks list \
--job=example-job \
--location=us-central1 \
--filter="FILTER_EXPRESSION"
Substitua FILTER_EXPRESSION
por uma expressão de filtro.
Por exemplo, é possível especificar a expressão de filtro a seguir para visualizar apenas as tarefas no grupo de tarefas de um job que estão em execução no momento ou que acabaram de ser executadas:
STATE=RUNNING OR STATE=SUCCEEDED
API
Para ver uma lista de tarefas no grupo de tarefas de um job usando a
API Batch, faça uma solicitação GET
para o
método tasks.list
:
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks
Substitua:
PROJECT_ID
: o ID do projeto atual.LOCATION
: o local em que o job está.JOB_NAME
: o nome de um job atual.TASK_GROUP_NAME
: o nome do grupo de tarefas com os detalhes que você quer ver. O valor precisa ser definido comogroup0
.
Também é possível especificar o parâmetro de consulta filter
para ver uma lista filtrada de tarefas no grupo de tarefas de um job com base em uma expressão de filtro.
Por exemplo, faça a seguinte solicitação GET
:
GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs/example-job/taskGroups/group0/tasks?filter=FILTER_EXPRESSION
Substitua FILTER_EXPRESSION
por uma expressão de filtro que use a codificação de URL.
Por exemplo, é possível especificar a expressão de filtro a seguir para visualizar apenas as tarefas no grupo de tarefas de um job que estão em execução no momento ou que acabaram de ser executadas:
STATE=RUNNING%20OR%20STATE=SUCCEEDED
A expressão de filtro codificada para URL representa a seguinte expressão de filtro decodificado:
STATE=RUNNING OR STATE=SUCCEEDED
Go
Go
Para mais informações, consulte a documentação de referência da API Go em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Java
Para mais informações, consulte a documentação de referência da API Java em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Node.js
Para mais informações, consulte a documentação de referência da API Node.js em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Python
Para mais informações, consulte a documentação de referência da API Python em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
C++
C++
Para mais informações, consulte a documentação de referência da API C++ em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ver os detalhes de uma tarefa
É possível visualizar os detalhes de uma tarefa usando o console do Google Cloud, a CLI gcloud, a API Batch, Go, Java, Node.js, Python ou C++.
Console
Para ver os detalhes de uma tarefa no grupo de tarefas de um job usando o console do Google Cloud, confira os detalhes de um job para abrir a página Detalhes do job e, em seguida, consulte a seção Detalhes da tarefa.
gcloud
Para visualizar os detalhes de uma tarefa usando a CLI gcloud, use o
comando gcloud batch tasks describe
com as sinalizações a seguir:
gcloud batch tasks describe TASK_INDEX \
--location=LOCATION \
--job=JOB_NAME \
--task_group=TASK_GROUP_NAME
Substitua:
TASK_INDEX
: o índice da tarefa com os detalhes que você quer ver. Os índices da tarefa em um grupo de tarefas começam em0
e aumentam em um para cada tarefa. Por exemplo, os índices de um grupo com quatro tarefas são0
,1
,2
e3
.TASK_GROUP_NAME
: o nome do grupo de tarefas que contém a tarefa com os detalhes que você quer ver. O valor precisa ser definido comogroup0
.JOB_NAME
: o nome de um job atual.LOCATION
: o local em que a vaga está.
API
Para visualizar os detalhes de uma tarefa usando a API Batch, faça uma solicitação GET
para o método tasks.get
:
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks/TASK_INDEX
Substitua:
PROJECT_ID
: o ID do projeto atual.LOCATION
: o local em que o job está.JOB_NAME
: o nome de um job atual.TASK_GROUP_NAME
: o nome do grupo de tarefas que contém a tarefa com os detalhes que você quer ver. O valor precisa ser definido comogroup0
.TASK_INDEX
: o índice da tarefa de que você quer ver os detalhes. Os índices da tarefa em um grupo de tarefas começam em0
e aumentam em um para cada tarefa. Por exemplo, os índices de um grupo com quatro tarefas são0
,1
,2
e3
.
Go
Go
Para mais informações, consulte a documentação de referência da API Go em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Java
Para mais informações, consulte a documentação de referência da API Java em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Node.js
Para mais informações, consulte a documentação de referência da API Node.js em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Python
Para mais informações, consulte a documentação de referência da API Python em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
C++
C++
Para mais informações, consulte a documentação de referência da API C++ em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
A seguir
Aprenda a analisar um job usando registros.
Saiba como organizar recursos usando rótulos.
Saiba como excluir e exportar jobs.