DescribeJobHistory - Serverless App Engine - Centro de documentación de Alibaba Cloud

Consulta la información sobre los trabajos.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

sae:DescribeJobHistory

*All Resource

*

Ninguna

Sintaxis de la solicitud

GET /pop/v1/sam/job/describeJobHistory HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
AppId	string	Sí	El ID de la plantilla de trabajo.	e1a7a07-abcb-4652-a1d3-2d57f415****
CurrentPage	integer	No	El número de la página a devolver.	1
PageSize	integer	No	El número de entradas a devolver en cada página. Valores válidos: 0 a 10000.	20
State	string	No	El estado del trabajo. Valores válidos: 0: El trabajo no se ha ejecutado. 1: El trabajo se ha ejecutado. 2: La ejecución del trabajo falló. 3: El trabajo se está ejecutando.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
RequestId	string	El ID de la solicitud.	53F15A18-8079-5992-810C-0211A5AE****
Message	string	El mensaje devuelto. Tenga en cuenta las siguientes reglas: Si la llamada es exitosa, se devuelve success. Si la llamada falla, se devuelve un código de error.	success
TraceId	string	El ID de rastreo que se utiliza para consultar los detalles de la solicitud.	0b1639af16575057857241351e****
Data	object	Los datos devueltos.
CurrentPage	integer	El número de página de la página devuelta.	1
TotalSize	integer	El número total de trabajos.	20
PageSize	integer	El número de entradas a devolver en cada página. Valores válidos: 0 a 10000.	20
Jobs	array<object>	Los trabajos.
	object
JobId	string	El ID del trabajo.	manual-3db7a8fa-5d40-4edc-92e4-49d50eab****
Active	integer	El número de instancias en ejecución.	0
Succeeded	integer	El número de instancias que se ejecutaron correctamente.	3
Failed	integer	El número de instancias cuya ejecución falló.	0
StartTime	integer	La hora en que se creó el trabajo.	1657522800
CompletionTime	integer	La hora en que se ejecutó el trabajo.	1657522839
Message	string	El mensaje devuelto si ocurren excepciones durante la ejecución del trabajo.
State	string	El estado del trabajo. Valores válidos: 0: El trabajo no se ejecutó. 1: El trabajo se ejecutó. 2: La ejecución del trabajo falló. 3: El trabajo se está ejecutando.	1
ErrorCode	string	El código de error devuelto. Tenga en cuenta las siguientes reglas: Si la llamada es exitosa, no se devuelve el parámetro ErrorCode. Si la llamada falla, se devuelve el parámetro ErrorCode. Para obtener más información, consulte la sección "Códigos de error" en este tema.
Code	string	El código de estado HTTP devuelto. Valores válidos: 2xx: La llamada fue exitosa. 3xx: La llamada fue redirigida. 4xx: La llamada falló. 5xx: Ocurrió un error del servidor.	200
Success	boolean	Indica si la llamada fue exitosa. Valores válidos: true false	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "53F15A18-8079-5992-810C-0211A5AE****",
  "Message": "success",
  "TraceId": "0b1639af16575057857241351e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 20,
    "PageSize": 20,
    "Jobs": [
      {
        "JobId": "manual-3db7a8fa-5d40-4edc-92e4-49d50eab****",
        "Active": 0,
        "Succeeded": 3,
        "Failed": 0,
        "StartTime": 1657522800,
        "CompletionTime": 1657522839,
        "Message": "",
        "State": "1"
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
404	InvalidAppId.NotFound	The specified AppId does not exist.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.