En este documento, se explica cómo ver los trabajos y las tareas de Batch.
Antes de comenzar
- Si no usaste Batch antes, revisa Comienza a usar Batch y habilita Batch. Para ello, completa los requisitos previos para proyectos y usuarios.
-
Si deseas obtener los permisos que necesitas para ver trabajos y tareas, pídele a tu administrador que te otorgue la función de IAM de visualizador de trabajos por lotes (
roles/batch.jobsViewer
) o editor de trabajos por lotes (roles/batch.jobsEditor
) en el proyecto. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso.Es posible que también puedas obtener los permisos necesarios a través de funciones personalizadas o, también, otras funciones predefinidas.
Ver tus trabajos
Para ver tus trabajos, selecciona uno de los siguientes métodos:
Para ver todos los trabajos en tu proyecto, consulta una lista de tus trabajos.
Para ver todos los detalles de configuración de un trabajo específico, consulta los detalles de un trabajo.
Consulta una lista de tus trabajos.
Puedes ver una lista de los trabajos del proyecto actual con la consola de Google Cloud, gcloud CLI, la API de Batch, Go, Java, Node.js, Python o C++.
Consola
Para ver una lista de trabajos en el proyecto actual con la consola de Google Cloud, ve a la página Lista de trabajos.
La lista de trabajos puede estar compuesta por varias páginas. Si necesitas pasar a la siguiente página, haz clic en
Siguiente, en la parte inferior de la pantalla.Opcional: Si deseas filtrar la lista de trabajos, haz clic en
Filtrar. Luego, escribe o selecciona una propiedad y un valor.Por ejemplo, si quieres filtrar la lista para que solo se incluyan trabajos en un estado específico, ingresa lo siguiente:
Status:JOB_STATE
Reemplaza
JOB_STATE
por un estado de trabajo, por ejemplo,FAILED
.
gcloud
Ver todos los trabajos
Para ver una lista de trabajos en el proyecto actual con gcloud CLI, usa el comando gcloud batch jobs list
.
gcloud batch jobs list
Consulta una lista filtrada de trabajos.
De manera opcional, puedes agregar una o más marcas para ver una lista filtrada de trabajos:
Para ver solo los trabajos en una ubicación específica, incluye la marca
--location
.Para ver solo los trabajos basados en una expresión de filtro, especifica la marca
--filter
.
Por ejemplo, usa el siguiente comando:
gcloud batch jobs list \
--location=LOCATION \
--filter="FILTER_EXPRESSION"
Reemplaza lo siguiente:
LOCATION
: Es la ubicación en la que existen uno o más trabajos.FILTER_EXPRESSION
: Es una expresión de filtro que define los trabajos que deseas enumerar. La expresión de filtro debe definir uno o más pares propiedad-valor separados por cero o más operadores booleanos (AND
,OR
yNOT
).Por ejemplo, consulta las siguientes expresiones de filtro:
Filtro basado en el estado del trabajo: Para ver solo los trabajos que se encuentren en un estado específico, usa la siguiente expresión de filtro:
status.state="JOB_STATE"
Reemplaza
JOB_STATE
por un estado de trabajo, por ejemplo,FAILED
.Filtro basado en etiquetas: Supongamos que tu proyecto definió las siguientes etiquetas personalizadas:
Para indicar los trabajos y sus recursos que crea el equipo de investigación cuando visualizas informes de Facturación de Cloud, algunos de tus trabajos y sus recursos tienen una etiqueta
team
configurada comoresearch
.Para indicar las cargas de trabajo urgentes, algunos trabajos tienen una etiqueta
deadline
, que se establece en varios valores.Para indicar los ejecutables que tu equipo de desarrollo probó con éxito, algunos ejecutables tienen una etiqueta
tested
establecida entrue
.
Luego, puedes especificar la siguiente expresión de filtro:
(allocationPolicy.labels.team=research) AND ((labels.deadline:*) OR (runnables.labels.tested=true))
Esta expresión de filtro solo enumera los trabajos que cumplen con todos los criterios siguientes:
Trabajos que son del equipo de investigación y que tienen una etiqueta
team
en la política de asignación del trabajo configurada comoresearch
.Trabajos que cumplen al menos uno de los siguientes criterios:
Trabajos urgentes que tienen una etiqueta
deadline
en el trabajo que se configura en cualquier valor.Trabajos que tienen al menos un ejecutable que se probó de forma correcta, que son trabajos que tienen al menos un ejecutable con una etiqueta
tested
configurada comotrue
API
Ver todos los trabajos
Para ver una lista de trabajos en el proyecto actual de una ubicación específica con la API de Batch, realiza una solicitud GET
al método jobs.list
.
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs
Reemplaza lo siguiente:
PROJECT_ID
: Es el ID del proyecto actual.LOCATION
: Es la ubicación en la que existen los trabajos.
Consulta una lista filtrada de trabajos.
De manera opcional, puedes especificar el parámetro de consulta filter
para ver una lista filtrada de trabajos según una expresión de filtro.
Por ejemplo, realiza la siguiente solicitud GET
:
GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?filter=FILTER_EXPRESSION
Reemplaza FILTER_EXPRESSION
por una expresión de filtro que use codificación de URL.
La expresión de filtro debe definir uno o más pares propiedad-valor separados por cero o más operadores booleanos (AND
, OR
y NOT
).
Por ejemplo, consulta las siguientes expresiones de filtro:
Filtro basado en el estado del trabajo: Para ver solo los trabajos que se encuentren en un estado específico, usa la siguiente expresión de filtro:
status.state="JOB_STATE"
Reemplaza
JOB_STATE
por un estado de trabajo, por ejemplo,FAILED
.Filtro basado en etiquetas: Supongamos que tu proyecto definió las siguientes etiquetas personalizadas:
Para indicar los trabajos y sus recursos que crea el equipo de investigación cuando visualizas informes de Facturación de Cloud, algunos de tus trabajos y sus recursos tienen una etiqueta
team
configurada comoresearch
.Para indicar las cargas de trabajo urgentes, algunos trabajos tienen una etiqueta
deadline
, que se establece en varios valores.Para indicar los ejecutables que tu equipo de desarrollo probó con éxito, algunos ejecutables tienen una etiqueta
tested
establecida entrue
.
Luego, puedes especificar la siguiente expresión de filtro:
(allocationPolicy.labels.team%3Dresearch)%20AND%20((labels.deadline%3A*)%20OR%20(runnables.labels.tested%3Dtrue))
Esta expresión de filtro solo enumera los trabajos que cumplen con todos los criterios siguientes:
Trabajos que son del equipo de investigación y que tienen una etiqueta
team
en la política de asignación del trabajo configurada comoresearch
.Trabajos que cumplen al menos uno de los siguientes criterios:
Trabajos urgentes que tienen una etiqueta
deadline
en el trabajo que se configura en cualquier valor.Trabajos que tienen al menos un ejecutable que se probó de forma correcta, que son trabajos que tienen al menos un ejecutable con una etiqueta
tested
configurada comotrue
Go
Go
Para obtener más información, consulta la documentación de referencia de la API de Batch Go.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Java
Para obtener más información, consulta la documentación de referencia de la API de Batch Java.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Node.js
Para obtener más información, consulta la documentación de referencia de la API de Batch Node.js.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Python
Para obtener más información, consulta la documentación de referencia de la API de Batch Python.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
C++
C++
Para obtener más información, consulta la documentación de referencia de la API de Batch C++.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Consulta los detalles de un trabajo
Puedes ver los detalles de un trabajo en el proyecto actual con la consola de Google Cloud, gcloud CLI, la API de Batch, Go, Java, Node.js, Python o C++.
Consola
Para ver los detalles de un trabajo en el proyecto actual con la consola de Google Cloud, sigue estos pasos:
En la consola de Google Cloud, ve a la página Lista de trabajos.
En la columna Nombre del trabajo, haz clic en el nombre de un trabajo.
Se abrirá la página Detalles del trabajo.
La pestaña Detalles se abre de forma predeterminada. Para obtener más información, haz clic en otras pestañas.
gcloud
Para ver los detalles de un trabajo en el proyecto actual con gcloud CLI, usa el comando gcloud batch jobs describe
con la marca --location
.
gcloud batch jobs describe JOB_NAME \
--location=LOCATION
Reemplaza lo siguiente:
JOB_NAME
: Es el nombre de un trabajo existente.LOCATION
: Es la ubicación en la que existe el trabajo.
API
Para ver los detalles de un trabajo en el proyecto actual con la API de Batch, realiza una solicitud GET
al método jobs.get
.
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME
Reemplaza lo siguiente:
PROJECT_ID
: Es el ID del proyecto actual.LOCATION
: Es la ubicación en la que existe el trabajo.JOB_NAME
: Es el nombre de un trabajo existente.
Go
Go
Para obtener más información, consulta la documentación de referencia de la API de Batch Go.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Java
Para obtener más información, consulta la documentación de referencia de la API de Batch Java.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Node.js
Para obtener más información, consulta la documentación de referencia de la API de Batch Node.js.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Python
Para obtener más información, consulta la documentación de referencia de la API de Batch Python.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
C++
C++
Para obtener más información, consulta la documentación de referencia de la API de Batch C++.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Ve las tareas
Para ver las tareas de uno de tus trabajos, selecciona uno de los siguientes métodos:
Para ver todas las tareas de un trabajo o el grupo de tareas de un trabajo, consulta una lista de las tareas de un trabajo.
Para ver todos los detalles de configuración de una tarea específica, consulta los detalles de una tarea.
Consulta una lista de las tareas de un trabajo
Puedes ver una lista de las tareas en un trabajo o en el grupo de tareas de un trabajo con la consola de Google Cloud, gcloud CLI, la API de Batch, Go, Java, Node.js, Python o C++.
Si deseas filtrar una lista de tareas en un trabajo o el grupo de tareas de un trabajo (por ejemplo, para enumerar solo las tareas que terminaron de ejecutarse de forma correcta), debes usar gcloud CLI o la API de Batch.
Consola
Si deseas ver un resumen de las tareas de un trabajo con Google Cloud Console, consulta los detalles de un trabajo para abrir la página Detalles del trabajo. Luego, consulta la sección Detalles de la tarea.
gcloud
Para ver una lista de las tareas en el grupo de tareas de un trabajo con gcloud CLI, usa el comando gcloud batch tasks list
con las siguientes marcas:
gcloud batch tasks list \
--job=JOB_NAME \
--location=LOCATION
Reemplaza lo siguiente:
JOB_NAME
: Es el nombre de un trabajo existente.LOCATION
: Es la ubicación en la que existe el trabajo.
De manera opcional, puedes agregar la marca --filter
para ver una lista filtrada de tareas en el grupo de tareas de un trabajo según una expresión de filtro.
Por ejemplo, usa el siguiente comando:
gcloud batch tasks list \
--job=example-job \
--location=us-central1 \
--filter="FILTER_EXPRESSION"
Reemplaza FILTER_EXPRESSION
por una expresión de filtro.
Por ejemplo, puedes especificar la siguiente expresión de filtro para ver solo las tareas en el grupo de tareas de un trabajo que están en ejecución o que terminaron de ejecutarse de forma correcta:
STATE=RUNNING OR STATE=SUCCEEDED
API
Para ver una lista de tareas en el grupo de tareas de un trabajo mediante la API de Batch, realiza una solicitud GET
al método tasks.list
:
GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks
Reemplaza lo siguiente:
PROJECT_ID
: Es el ID del proyecto actual.LOCATION
: Es la ubicación en la que existe el trabajo.JOB_NAME
: Es el nombre de un trabajo existente.TASK_GROUP_NAME
: Es el nombre del grupo de tareas del que deseas ver los detalles. El valor se debe configurar comogroup0
.
De manera opcional, puedes especificar el parámetro de consulta filter
para ver una lista filtrada de tareas en el grupo de tareas de un trabajo según una expresión de filtro.
Por ejemplo, realiza la siguiente solicitud GET
:
GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs/example-job/taskGroups/group0/tasks?filter=FILTER_EXPRESSION
Reemplaza FILTER_EXPRESSION
por una expresión de filtro que use codificación de URL.
Por ejemplo, puedes especificar la siguiente expresión de filtro para ver solo las tareas en el grupo de tareas de un trabajo que están en ejecución o que terminaron de ejecutarse de forma correcta:
STATE=RUNNING%20OR%20STATE=SUCCEEDED
Ten en cuenta que la expresión de filtro codificada para URL representa la siguiente expresión de filtro decodificada:
STATE=RUNNING OR STATE=SUCCEEDED
Go
Go
Para obtener más información, consulta la documentación de referencia de la API de Batch Go.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Java
Para obtener más información, consulta la documentación de referencia de la API de Batch Java.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Node.js
Para obtener más información, consulta la documentación de referencia de la API de Batch Node.js.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Python
Para obtener más información, consulta la documentación de referencia de la API de Batch Python.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
C++
C++
Para obtener más información, consulta la documentación de referencia de la API de Batch C++.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Cómo ver los detalles de una tarea
Puedes ver los detalles de una tarea con la consola de Google Cloud, gcloud CLI, la API de Batch, Go, Java, Node.js, Python o C++.
Consola
Para ver los detalles de una tarea con la consola de Google Cloud, consulta los detalles de un trabajo para abrir la página Detalles del trabajo. Luego, consulta la sección Detalles de la tarea.
gcloud
Para ver los detalles de una tarea con gcloud CLI, usa el comando gcloud batch tasks describe
con las siguientes marcas:
gcloud batch tasks describe TASK_INDEX \
--location=LOCATION \
--job=JOB_NAME \
--task_group=TASK_GROUP_NAME
Reemplaza lo siguiente:
TASK_INDEX
: El índice de la tarea de la que deseas ver los detalles. En un grupo de tareas, el índice de tareas comienza en 0 para la primera tarea y aumenta en 1 con cada tarea adicional. Por ejemplo, un grupo de tareas que contiene cuatro tareas tiene los índices0
,1
,2
y3
.TASK_GROUP_NAME
: Es el nombre del grupo de tareas que contiene la tarea de la que deseas ver los detalles. El valor se debe configurar comogroup0
.JOB_NAME
: Es el nombre de un trabajo existente.LOCATION
: Es la ubicación en la que existe el trabajo.
API
Para ver los detalles de una tarea con la API de Batch, realiza una solicitud GET
al 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
Reemplaza lo siguiente:
PROJECT_ID
: Es el ID del proyecto actual.LOCATION
: Es la ubicación en la que existe el trabajo.JOB_NAME
: Es el nombre de un trabajo existente.TASK_GROUP_NAME
: Es el nombre del grupo de tareas que contiene la tarea de la que deseas ver los detalles. El valor se debe configurar comogroup0
.TASK_INDEX
: El índice de la tarea de la que deseas ver los detalles. En un grupo de tareas, el índice de tareas comienza en 0 para la primera tarea y aumenta en 1 con cada tarea adicional. Por ejemplo, un grupo de tareas que contiene cuatro tareas tiene los índices0
,1
,2
, y3
.
Go
Go
Para obtener más información, consulta la documentación de referencia de la API de Batch Go.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Java
Para obtener más información, consulta la documentación de referencia de la API de Batch Java.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Node.js
Para obtener más información, consulta la documentación de referencia de la API de Batch Node.js.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Python
Para obtener más información, consulta la documentación de referencia de la API de Batch Python.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
C++
C++
Para obtener más información, consulta la documentación de referencia de la API de Batch C++.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
¿Qué sigue?
Aprende a supervisar y analizar trabajos:
Supervisa y optimiza los recursos del trabajo mediante la visualización de las métricas.
Si configuraste registros para un trabajo, puedes analizar un trabajo con registros.
Si configuraste notificaciones de estado, puedes supervisar un trabajo con notificaciones de Pub/Sub y analizar notificaciones con BigQuery.
Obtén más información sobre cómo organizar los recursos con etiquetas.
Obtén más información sobre cómo borrar y exportar trabajos.