Mostrar trabajos (API RESTful) - Teradata Data Mover

Propósito

Parámetros de solicitud (/datamover/jobs)

Esta variación devuelve una lista de nombres de trabajo que cumplen las condiciones especificadas, incluidos la hora de inicio, la hora de finalización y el estado. Si no se proporciona ningún parámetro, se devuelve una lista de trabajos nuevos y completados.

startTimeAfter

Descripción: Trabajos que se han iniciado después de la hora especificada

Restricción: No puede utilizarse con endTimeAfter

URL: /datamover/jobs?startTimeAfter=value

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

Obligatorio: No

endTimeBefore

Descripción: Trabajos que han finalizado antes de la hora especificada

Restricción: No puede utilizarse con endTimeAfter

URL: /datamover/jobs?endTimeBefore=value

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

Obligatorio: No

endTimeAfter

Descripción: trabajos que han finalizado después de la hora especificada

Restricción: No se puede utilizar con endTimeBefore o startTimeAfter.

URL: /datamover/jobs?endTimeAfter=value

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

Obligatorio: No

freezeJobStepsOnly

Descripción: Muestre solo los trabajos en los que freezeJobStepsOnly se haya configurado en true

URL: /datamover/jobs?freezeJobStepsOnly=value

Valores aceptados: True o False

• true = muestra los trabajos que tienen pasos de trabajo de bloqueo
• false = devuelve todos los trabajos, independientemente de los pasos de bloqueo

Tipo de datos JSON: Booleano

Obligatorio: No

jobName

Descripción: Nombre del trabajo

Tipo de datos JSON: Cadena

Obligatorio: No

latestJobsOnly

Descripción: Muestre el trabajo más reciente que se ejecutó en el daemon.

URL: /datamover/jobs?latestJobsOnly=value

Valores aceptados: True o False

• true = solo muestra el trabajo ejecutado más recientemente
• false = muestra todos los trabajos

Tipo de datos JSON: Booleano

Obligatorio: No

status

Descripción: los trabajos cuyo último estado de inicio coincide con uno de los siguientes:

• NEW: todos los trabajos nuevos.
• INITIALIZING: todos los trabajos que se están inicializando.
• RUNNING: todos los trabajos en ejecución.
• BLOCKED: todos los trabajos bloqueados.
• COMPLETED: todos los trabajos completados correctamente.
• FAILED: todos los trabajos con errores.
• RESTARTING: todos los trabajos que se están reiniciando.
• CANCELLED: todos los trabajos cancelados por el usuario.
• QUEUED: todos los trabajos en cola.

URL: /datamover/jobs?status=value

Tipo de datos JSON: Cadena

Obligatorio: No

Parámetros de respuesta (/datamover/jobs)

jobExecutionName

Descripción: nombre de trabajo iniciado

Tipo de datos JSON: Cadena

jobName

Descripción: Nombre del trabajo (número máximo de caracteres: 237)

Tipo de datos JSON: Cadena

startTime

Descripción: hora de inicio si se ha iniciado el trabajo o null si no se ha iniciado

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

endTime

Descripción: hora de finalización si se ha iniciado el trabajo o null si no se ha iniciado

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

status

Descripción: estado del trabajo (máximo de caracteres: 12), donde los posibles valores se especifican en la sección Parámetros de solicitud

Tipo de datos JSON: Cadena

Priority

Descripción: la prioridad del trabajo si se inició (máximo de caracteres: 11), con uno de los siguientes valores:

• UNSPECIFIED
• LOW
• MEDIUM
• HIGH

Tipo de datos JSON: Cadena

Ejemplo de respuesta (/datamover/jobs))

[
     {
         "jobName" :  "runningJob" ,
         "startTime" : "2015-07-16T17:14:13Z",
         "endTime" :  null ,
         "status" :  "RUNNING" ,
         "priority" :  "MEDIUM" ,
         "links" : 
          [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executingJobs/runningJob-1417744247669"
                              
             },
             {
                 "rel" :  "past_executions" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=runningJob&startTimeAfter=<value>"
                              
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/runningJob/steps"
                              
             }
         ]
     },
     {
         "jobName" :  "successfulJob" ,
         "startTime" : "2015-07-16T17:14:13Z",
         "endTime" : "2015-07-16T19:14:13Z",
         "status" :  "COMPLETED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/successfulJob-20141204175020"
                              
             },
             {
                 "rel" :  "past_executions" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=successfulJob
                                &startTimeAfter=<value>
                                "
                              
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/successfulJob/steps"
                              
             }
         ]
     },
     {
         "jobName" :  "failedJob" ,
         "startTime" : 1417744247669,
         "endTime" : 1417744323437,
         "status" :  "FAILED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/failedJob-20141204175020"
                              
             },
             {
                 "rel" :  "past_executions" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=failedJob
                                &startTimeAfter=<value>
                                "
                              
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/failedJob/steps"
                              
             }
         ]
     }
]             

Parámetros de solicitud (/datamover/executedJobs)

Esta variación devuelve una lista de nombres de trabajo que cumplen las condiciones especificadas, incluidos los trabajos nuevos o en ejecución.

startTimeAfter

Descripción: Trabajos que se han iniciado después de la hora especificada

Restricción: No puede utilizarse con endTimeAfter

URL: /datamover/executedJobs

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

Obligatorio: No

endTimeBefore

Descripción: trabajos que han finalizado antes de la hora especificada

Restricción: No puede utilizarse con endTimeAfter

URL: /datamover/executedJobs?endTimeBefore=value

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

Obligatorio: No

endTimeAfter

Descripción: Trabajos que han finalizado después de la hora especificada

Restricción: No se puede utilizar con startTimeAfter o endTimeBefore.

URL: /datamover/executedJobs?endTimeBefore=value

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

Obligatorio: No

status

Descripción: los trabajos cuyo último estado de ejecución coincide con uno de los siguientes:

• COMPLETADOS: todos los trabajos completados correctamente.
• ERROR: todos los trabajos con error.
• CANCELADOS: todos los trabajos cancelados por el usuario.

URL: /datamover/executedJobs?endTimeBefore=value

Tipo de datos JSON: Cadena

Obligatorio: No

jobName

Descripción: trabajos iniciados asignados al nombre especificado

URL: /datamover/executedJobs?jobName=value

Tipo de datos JSON: Cadena

Obligatorio: No

Parámetros de respuesta (/datamover/executedJobs)

jobExecutionName

Descripción: nombre de trabajo iniciado

Tipo de datos JSON: Cadena

jobName

Descripción: Nombre del trabajo (número máximo de caracteres: 237)

Tipo de datos JSON: Cadena

startTime

Descripción: hora de inicio si se ha iniciado el trabajo o null si no se ha iniciado

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

endTime

Descripción: hora de finalización si se ha iniciado el trabajo o null si no se ha iniciado

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

status

Descripción: Estado del trabajo (máximo de caracteres: 11), donde los valores posibles se enumeran en la sección Parámetros de solicitud

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

Priority

Descripción: la prioridad del trabajo si se ha iniciado (número máximo de caracteres: 11), y en el momento en el que se ejecuta, con uno de los siguientes valores:

• UNSPECIFIED
• LOW
• MEDIUM
• HIGH

Tipo de datos JSON: Cadena

Ejemplo de la API RESTful (/datamover/executedJobs)

[
     {
         "jobExecutionName" :  "successfulJob-20141204175020" ,
         "jobName" :  "successfulJob" ,
         "startTime" :"2015-07-01T17:38:12Z",
         "endTime" : "2015-07-01T19:38:12Z",
         "status" :  "COMPLETED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/successfulJob-20141204175020"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/successfulJob/steps"
                              
             }
         ]
     },
     {
         "jobExecutionName" :  "successfulJob-20141204175111" ,
         "jobName" :  "successfulJob" ,
         "startTime" : "2015-07-02T17:38:12Z",
         "endTime" : "2015-07-02T19:38:12Z",
         "status" :  "COMPLETED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/successfulJob-20141204175111"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/successfulJob/steps"
                              
             }
         ]
     },
     {
         "jobExecutionName" :  "failedJob-20141204175020" ,
         "jobName" :  "failedJob" ,
         "startTime" : "2015-07-03T17:38:12Z",
         "endTime" : "2015-07-03T19:38:12Z",
         "status" :  "FAILED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/failedJob-20141204175020"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/failedJob/steps"
                              
             }
         ]
     }
]     

Parámetros de solicitud (/datamover/executingJobs)

Parámetros de respuesta (/datamover/executingJobs)

jobExecutionName

Descripción: nombre de trabajo iniciado

Tipo de datos JSON: Cadena

jobName

Descripción: Nombre del trabajo (número máximo de caracteres: 237)

Tipo de datos JSON: Cadena

startTime

Descripción: hora de inicio si se ha iniciado el trabajo o null si no se ha iniciado

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

status

Descripción: Estado del trabajo (máximo de caracteres: 11), donde los posibles valores se especifican en la lista Parámetros de solicitud

Tipo de datos JSON: Cadena

Priority

Descripción: la prioridad del trabajo si se ha iniciado (número máximo de caracteres: 11), y en el momento en el que se ejecuta, con uno de los siguientes valores:

• UNSPECIFIED
• LOW
• MEDIUM
• HIGH

Tipo de datos JSON: Cadena

Ejemplo de la API RESTful (/datamover/executingJobs)

[
         {
         "jobExecutionName" :  "runningJob-1417744247669" ,
         "jobName" :  "runningJob" ,
         "startTime" :"2015-07-16T17:14:13Z",
         "status" :  "RUNNING" ,
         "priority" :  "MEDIUM" ,
         "links" : 
          [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/runningJobs/runningJob-1417744247669"
                          
             },
             {
                 "rel" :  "history" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=runningJob&startTimeAfter=<value>"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/runningJob/steps"
                              
             }
         ]
     }
] 

Parámetros de solicitud (/datamover/jobs?freezeJobStepsOnly=value)

freezeJobStepsOnly

Descripción: Los trabajos que tienen pasos de trabajo de bloqueo configurados en true

Tipo de datos JSON: Booleano

Obligatorio: No

Valores aceptados: True o False

• true = muestra los trabajos que tienen pasos de trabajo de bloqueo
• false = devuelve todos los trabajos, independientemente de los pasos de bloqueo

Parámetros de respuesta (/datamover/jobs?freezeJobStepsOnly=value)

jobExecutionName

Descripción: nombre de trabajo iniciado

Tipo de datos JSON: Cadena

jobName

Descripción: Nombre del trabajo (número máximo de caracteres: 237)

Tipo de datos JSON: Cadena

links

Descripción: Lista de enlaces al estado del trabajo, ejecuciones de trabajos anteriores y pasos del trabajo

Tipo de datos JSON: matriz JSON (LinkType)

Priority

Descripción: la prioridad del trabajo si se ha iniciado (número máximo de caracteres: 11), y en el momento en el que se ejecuta, con uno de los siguientes valores:

• UNSPECIFIED
• LOW
• MEDIUM
• HIGH

Tipo de datos JSON: Cadena

startTime

Descripción: Hora de inicio del trabajo

Tipo de datos JSON: cadena (con el formato de fecha UTC ISO 8601), por ejemplo: 2015-07-01T17:38:12Z

status

Descripción: Estado del trabajo (máximo de caracteres: 12), donde los posibles valores se especifican en la descripción de Parámetros de solicitud

Tipo de datos JSON: Cadena