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

Llama a ExecJob para ejecutar un trabajo.

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:ExecJob

*All Resource

*

Ninguna

Sintaxis de la solicitud

GET /pop/v1/sam/job/execJob 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.	ee1a7a07-abcb-4652-a1d3-2d57f415****
EventId	string	No	Un ID de evento personalizable que garantiza la idempotencia. El sistema crea solo un trabajo para las solicitudes que tienen el mismo ID de evento.	custom
Command	string	No	El comando de inicio, que debe ser un ejecutable que exista en el contenedor. Ejemplo: `command: - echo - abc - > - file0` Según este ejemplo, `Command` es `echo` y `CommandArgs` es `["abc", ">", "file0"]`.	echo
CommandArgs	string	No	Los argumentos para el parámetro Command. El valor debe ser una cadena que represente una matriz JSON. Formato: `["a","b"]` En el ejemplo anterior del parámetro `Command`, `CommandArgs` es `["abc", ">", "file0"]`. La matriz JSON `["abc", ">", "file0"]` debe convertirse a una cadena. Este parámetro es opcional.	["a","b"]
Envs	string	No	Las variables de entorno del contenedor. Puede especificar variables de entorno personalizadas o hacer referencia a un ConfigMap existente. Para obtener más información sobre cómo crear un ConfigMap, consulte CreateConfigMap. Configuración personalizada name: El nombre de la variable de entorno. value: El valor de la variable de entorno. Referencia a un ConfigMap name: El nombre de la variable de entorno. Puede hacer referencia a una sola clave o a todas las claves. Para hacer referencia a todas las claves, utilice el formato `sae-sys-configmap-all-<nombre del ConfigMap>`. Ejemplo: `sae-sys-configmap-all-test1`. valueFrom: El origen de la variable de entorno. Establezca el valor en `configMapRef`. configMapId: El ID del ConfigMap. key: La clave a la que desea hacer referencia. Si desea hacer referencia a todos los pares clave-valor, no especifique este parámetro.	[{"name":"envtmp","value":"0"}]
JarStartOptions	string	No	Opciones para iniciar un trabajo desplegado desde un paquete JAR. El comando de inicio predeterminado es: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArg`	-Xms4G -Xmx4G
JarStartArgs	string	No	Argumentos para iniciar un trabajo desplegado desde un paquete JAR. El comando de inicio predeterminado es: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`	custom-args
WarStartOptions	string	No	El comando de inicio para un trabajo desplegado desde un paquete WAR. La configuración es la misma que para un despliegue basado en imágenes. Para obtener más información, consulte Configurar un comando de inicio.	CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run
Time	string	No	La hora para activar el trabajo, especificada en el formato `yyyy-MM-dd'T'HH:mm:ss'Z'`.	2023-09-14T14:25:02Z
Replicas	string	No	El número de instancias simultáneas.	3

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
RequestId	string	El ID de la solicitud.	67DD9A98-9CCC-5BE8-8C9E-B45E72F4****
Message	string	El mensaje devuelto. Si la solicitud se realiza correctamente, se devuelve success. Si la solicitud falla, se devuelve un código de error.	success
TraceId	string	El ID de rastreo para recuperar información detallada sobre la llamada.	0b87b7e716575071334387401e****
Data	object	Los datos devueltos.
Data	string	El ID del trabajo.	manual-3db7a8fa-5d40-4edc-92e4-49d50eab****
Msg	string	El mensaje devuelto. Si la solicitud se realiza correctamente, se devuelve success. Si la solicitud falla, se devuelve un código de error.	success
Success	string	Indica si el trabajo se ejecutó correctamente. true: La ejecución fue exitosa. false: La ejecución falló.	true
Code	string	El código de estado HTTP o un código de error POP. 2xx: Éxito. 3xx: Redireccionamiento. 4xx: Error de solicitud. 5xx: Error del servidor.	200
ErrorCode	string	El código de error. Este parámetro se omite en las solicitudes exitosas. Este parámetro se incluye en las solicitudes fallidas. Para obtener más información, consulte la sección Códigos de error de este tema.
Code	string	El código de estado HTTP o un código de error POP. 2xx: Éxito. 3xx: Redireccionamiento. 4xx: Error de solicitud. 5xx: Error del servidor.	200
Success	boolean	Indica si la solicitud fue exitosa. true: La solicitud fue exitosa. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "67DD9A98-9CCC-5BE8-8C9E-B45E72F4****",
  "Message": "success",
  "TraceId": "0b87b7e716575071334387401e****",
  "Data": {
    "Data": "manual-3db7a8fa-5d40-4edc-92e4-49d50eab****",
    "Msg": "success",
    "Success": "true",
    "Code": "200"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InvalidApplication.NotFound	The current application does not exist.
400	JobForbidPolicy	You cannot execute new jobs because ongoing jobs exist.
400	JobSuspend	The job is suspended.
400	user.indebt	The user has an outstanding payment.

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.