Neste documento, explicamos como visualizar jobs e tarefas em lote.
Antes de começar
- Se você nunca usou o Batch, consulte Começar a usar o Batch e ative o Batch concluindo os pré-requisitos para projetos e usuários.
-
Para receber as permissões necessárias para visualizar jobs e tarefas, peça ao administrador para conceder a você o papel do IAM de Leitor de jobs em lote (
roles/batch.jobsViewer
) ou Editor de jobs em lote (roles/batch.jobsEditor
) no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.
Acessar seus trabalhos
Para conferir seus jobs, selecione um dos seguintes métodos:
Para conferir todos os jobs no projeto, confira uma lista deles.
Para conferir todos os detalhes de configuração de um job específico, confira os detalhes de um job.
Conferir uma lista dos seus jobs
É possível conferir uma lista de jobs no projeto atual usando o console do Google Cloud, a CLI gcloud, a API Batch, Go, Java, Node.js, Python ou C++.
Console
Para conferir uma lista de jobs no projeto atual usando o console do Google Cloud, acesse a página Lista de jobs.
A lista de jobs pode ter várias páginas. Se você precisar continuar para a próxima página, clique em
Próxima na parte de baixo da tela.Opcional: se quiser filtrar a lista de jobs, clique em
Filtrar. Em seguida, digite ou selecione uma propriedade e um valor.Por exemplo, para filtrar a lista e incluir apenas jobs em um estado específico, insira o seguinte:
Status:JOB_STATE
Substitua
JOB_STATE
por um estado de trabalho, por exemplo,FAILED
.
gcloud
Ver todos os jobs
Para conferir uma lista de jobs no projeto atual usando a
CLI gcloud, use o
comando gcloud batch jobs list
.
gcloud batch jobs list
Conferir uma lista filtrada de jobs
Opcionalmente, adicione uma ou mais flags para consultar uma lista filtrada de trabalhos:
Para visualizar apenas jobs em um local específico, inclua a flag
--location
.Para visualizar apenas jobs com base em uma expressão de filtro, especifique a flag
--filter
.
Por exemplo, use o seguinte comando:
gcloud batch jobs list \
--location=LOCATION \
--filter="FILTER_EXPRESSION"
Substitua:
LOCATION
: o local em que um ou mais jobs existem.FILTER_EXPRESSION
: uma expressão de filtro que define os trabalhos que você quer listar. A expressão de filtro precisa definir um ou mais pares de propriedade-valor separados por zero ou mais operadores booleanos (AND
,OR
eNOT
).Por exemplo, confira as seguintes expressões de filtro:
Filtro com base no estado do job:para visualizar apenas os jobs que estão em um estado específico, use a seguinte expressão de filtro:
status.state="JOB_STATE"
Substitua
JOB_STATE
por um estado de trabalho, por exemplo,FAILED
.Filtrar com base em rótulos:suponha que seu projeto tenha definido os seguintes rótulos personalizados:
Para indicar jobs e os recursos deles criados pela equipe de pesquisa quando você consulta os relatórios do Cloud Billing, alguns jobs e os recursos deles têm um rótulo
team
definido comoresearch
.Para indicar cargas de trabalho sensíveis ao tempo, alguns jobs têm um rótulo
deadline
, que é definido para vários valores.Para indicar que os runnables foram testados pela equipe de desenvolvimento, alguns deles têm um rótulo
tested
definido comotrue
.
Em seguida, especifique a seguinte expressão de filtro:
(allocationPolicy.labels.team=research) AND ((labels.deadline:*) OR (runnables.labels.tested=true))
Essa expressão de filtro lista apenas os jobs que atendem a todos os seguintes critérios:
Jobs da equipe de pesquisa que têm um rótulo
team
na política de alocação do job definida comoresearch
.Jobs que atendem a pelo menos um dos seguintes critérios:
Jobs que são sensíveis ao tempo e têm um rótulo
deadline
no job definido como qualquer valor.Jobs que têm pelo menos um executável testado com sucesso, ou seja, jobs que têm pelo menos um executável com um rótulo
tested
definido comotrue
.
API
Ver todos os jobs
Para conferir 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 atual.LOCATION
: o local em que os jobs existem.
Conferir uma lista filtrada de jobs
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 codificação de URL.
A expressão de filtro precisa definir um ou mais pares de propriedade-valor separados por zero ou mais operadores booleanos (AND
, OR
e NOT
).
Por exemplo, confira as seguintes expressões de filtro:
Filtro com base no estado do job:para visualizar apenas os jobs que estão em um estado específico, use a seguinte expressão de filtro:
status.state="JOB_STATE"
Substitua
JOB_STATE
por um estado de trabalho, por exemplo,FAILED
.Filtrar com base em rótulos:suponha que seu projeto tenha definido os seguintes rótulos personalizados:
Para indicar jobs e os recursos deles criados pela equipe de pesquisa quando você consulta os relatórios do Cloud Billing, alguns jobs e os recursos deles têm um rótulo
team
definido comoresearch
.Para indicar cargas de trabalho sensíveis ao tempo, alguns jobs têm um rótulo
deadline
, que é definido para vários valores.Para indicar que os runnables foram testados pela equipe de desenvolvimento, alguns deles têm um rótulo
tested
definido comotrue
.
Em seguida, especifique a seguinte expressão de filtro:
(allocationPolicy.labels.team%3Dresearch)%20AND%20((labels.deadline%3A*)%20OR%20(runnables.labels.tested%3Dtrue))
Essa expressão de filtro lista apenas os jobs que atendem a todos os seguintes critérios:
Jobs da equipe de pesquisa que têm um rótulo
team
na política de alocação do job definida comoresearch
.Jobs que atendem a pelo menos um dos seguintes critérios:
Jobs que são sensíveis ao tempo e têm um rótulo
deadline
no job definido como qualquer valor.Jobs que têm pelo menos um executável testado com sucesso, ou seja, jobs que têm pelo menos um executável com um rótulo
tested
definido comotrue
.
Go
Go
Para mais informações, consulte a documentação de referência da API Batch Go.
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 Batch Java.
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 Batch Node.js.
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 Batch Python.
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 Batch C++.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Conferir os detalhes de um job
É possível conferir os detalhes de um job no projeto atual usando o console do Google Cloud, a CLI gcloud, a API Batch, Go, Java, Node.js, Python ou C++.
Console
Para conferir 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 será aberta.
A guia Detalhes é aberta por padrão. Para mais informações, clique em outras guias.
gcloud
Para conferir os detalhes de um job no projeto atual usando a
CLI gcloud, use o
comando gcloud batch jobs describe
com a flag --location
.
gcloud batch jobs describe JOB_NAME \
--location=LOCATION
Substitua:
JOB_NAME
: o nome de um job existente.LOCATION
: o local em que o job existe.
API
Para conferir 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 existe.JOB_NAME
: o nome de um job existente.
Go
Go
Para mais informações, consulte a documentação de referência da API Batch Go.
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 Batch Java.
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 Batch Node.js.
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 Batch Python.
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 Batch C++.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Conferir tarefas
Para conferir as tarefas de um dos seus jobs, selecione um destes métodos:
Para conferir todas as tarefas de um job ou grupo de tarefas, acesse uma lista de tarefas de um job.
Para conferir todos os detalhes de configuração de uma tarefa específica, confira os detalhes de uma tarefa.
Conferir uma lista de tarefas de um job
É possível conferir uma lista das tarefas em um job ou no grupo de tarefas de um job 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 no grupo de tarefas de um job, por exemplo, para listar apenas as tarefas que foram concluídas com sucesso, use a CLI gcloud ou a API Batch.
Console
Para conferir um resumo das tarefas de um job usando o console do Google Cloud, acesse os detalhes de um job para abrir a página Detalhes do job. Em seguida, consulte a seção Detalhes da tarefa.
gcloud
Para conferir uma lista das tarefas em um grupo de tarefas de um job usando a
CLI gcloud, use o
comando gcloud batch tasks list
com as seguintes flags:
gcloud batch tasks list \
--job=JOB_NAME \
--location=LOCATION
Substitua:
JOB_NAME
: o nome de um job existente.LOCATION
: o local em que o job existe.
Também é possível adicionar a flag --filter
para consultar 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 seguinte expressão de filtro para ver apenas as tarefas no grupo de tarefas de um job que estão em execução ou que foram concluídas:
STATE=RUNNING OR STATE=SUCCEEDED
API
Para conferir uma lista de tarefas em um 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 existe.JOB_NAME
: o nome de um job existente.TASK_GROUP_NAME
: o nome do grupo de tarefas que você quer consultar. O valor precisa ser definido comogroup0
.
Também é possível especificar o parâmetro de consulta filter
para consultar 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 codificação de URL.
Por exemplo, é possível especificar a seguinte expressão de filtro para ver apenas as tarefas no grupo de tarefas de um job que estão em execução ou que foram concluídas:
STATE=RUNNING%20OR%20STATE=SUCCEEDED
A expressão de filtro codificada para URL representa a seguinte expressão de filtro decodificada:
STATE=RUNNING OR STATE=SUCCEEDED
Go
Go
Para mais informações, consulte a documentação de referência da API Batch Go.
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 Batch Java.
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 Batch Node.js.
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 Batch Python.
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 Batch C++.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Conferir os detalhes de uma tarefa
É possível conferir 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 conferir os detalhes de uma tarefa usando o console do Google Cloud, acesse os detalhes de um job para abrir a página Detalhes do job. Em seguida, consulte a seção Detalhes da tarefa.
gcloud
Para conferir os detalhes de uma tarefa usando a CLI gcloud, use o
comando gcloud batch tasks describe
com as seguintes flags:
gcloud batch tasks describe TASK_INDEX \
--location=LOCATION \
--job=JOB_NAME \
--task_group=TASK_GROUP_NAME
Substitua:
TASK_INDEX
: o índice da tarefa cujos detalhes você quer ver. Em um grupo de tarefas, o índice começa em 0 para a primeira tarefa e aumenta em 1 a cada tarefa adicional. Por exemplo, um grupo de tarefas que contém quatro tarefas tem os índices0
,1
,2
e3
.TASK_GROUP_NAME
: o nome do grupo de tarefas que contém a tarefa que você quer consultar os detalhes. O valor precisa ser definido comogroup0
.JOB_NAME
: o nome de um job existente.LOCATION
: o local em que o job existe.
API
Para conferir 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 existe.JOB_NAME
: o nome de um job existente.TASK_GROUP_NAME
: o nome do grupo de tarefas que contém a tarefa que você quer consultar os detalhes. O valor precisa ser definido comogroup0
.TASK_INDEX
: o índice da tarefa que você quer ver os detalhes. Em um grupo de tarefas, o índice começa em 0 para a primeira tarefa e aumenta em 1 a cada tarefa adicional. Por exemplo, um grupo de tarefas que contém quatro tarefas tem os índices0
,1
,2
e3
.
Go
Go
Para mais informações, consulte a documentação de referência da API Batch Go.
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 Batch Java.
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 Batch Node.js.
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 Batch Python.
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 Batch C++.
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
Saiba como resolver problemas.
Saiba como monitorar e analisar jobs:
Monitore e otimize os recursos de jobs conferindo as métricas.
Se você configurou registros para um job, é possível analisá-lo usando registros.
Se você tiver configurado notificações de status, poderá monitorar um job usando notificações do Pub/Sub e analisar notificações usando o BigQuery.
Saiba como gerenciar jobs: