ExecJob - Serverless App Engine: Central de Documentação do Alibaba Cloud

Chama ExecJob para executar um job.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

sae:ExecJob

*All Resource

*

Nenhuma

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID do modelo de job.	ee1a7a07-abcb-4652-a1d3-2d57f415****
EventId	string	Não	Um ID de evento personalizável que garante a idempotência. O sistema cria apenas um job para solicitações que possuem o mesmo ID de evento.	custom
Command	string	Não	O comando de inicialização, que deve ser um executável existente no contêiner. Exemplo: `command: - echo - abc - > - file0` Com base neste exemplo, `Command` é `echo` e `CommandArgs` é `["abc", ">", "file0"]`.	echo
CommandArgs	string	Não	Os argumentos para o parâmetro Command. O valor deve ser uma string que representa uma matriz JSON. Formato: `["a","b"]` No exemplo anterior para o parâmetro `Command`, `CommandArgs` é `["abc", ">", "file0"]`. A matriz JSON `["abc", ">", "file0"]` deve ser convertida em uma string. Este parâmetro é opcional.	["a","b"]
Envs	string	Não	As variáveis de ambiente do contêiner. Você pode especificar variáveis de ambiente personalizadas ou referenciar um ConfigMap existente. Para obter mais informações sobre como criar um ConfigMap, consulte CreateConfigMap. Configuração personalizada name: O nome da variável de ambiente. value: O valor da variável de ambiente. Referenciar um ConfigMap name: O nome da variável de ambiente. Você pode referenciar uma única chave ou todas as chaves. Para referenciar todas as chaves, use o formato `sae-sys-configmap-all-<nome do ConfigMap>`. Exemplo: `sae-sys-configmap-all-test1`. valueFrom: A origem da variável de ambiente. Defina o valor como `configMapRef`. configMapId: O ID do ConfigMap. key: A chave que você deseja referenciar. Se quiser referenciar todos os pares chave-valor, não especifique este parâmetro.	[{"name":"envtmp","value":"0"}]
JarStartOptions	string	Não	Opções para iniciar um job implantado a partir de um pacote JAR. O comando de inicialização padrão é: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArg`	-Xms4G -Xmx4G
JarStartArgs	string	Não	Argumentos para iniciar um job implantado a partir de um pacote JAR. O comando de inicialização padrão é: `$JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs`	custom-args
WarStartOptions	string	Não	O comando de inicialização para um job implantado a partir de um pacote WAR. A configuração é a mesma de uma implantação baseada em imagem. Para obter mais informações, consulte Configurar um comando de inicialização.	CATALINA_OPTS=\"$CATALINA_OPTS $Options\" catalina.sh run
Time	string	Não	O horário para acionar o job, especificado no formato `yyyy-MM-dd'T'HH:mm:ss'Z'`.	2023-09-14T14:25:02Z
Replicas	string	Não	O número de instâncias simultâneas.	3

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	67DD9A98-9CCC-5BE8-8C9E-B45E72F4****
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, success será retornado. Se a solicitação falhar, um código de erro será retornado.	success
TraceId	string	O ID de rastreamento para recuperar informações detalhadas sobre a chamada.	0b87b7e716575071334387401e****
Data	object	Os dados retornados.
Data	string	O ID do job.	manual-3db7a8fa-5d40-4edc-92e4-49d50eab****
Msg	string	A mensagem retornada. Se a solicitação for bem-sucedida, success será retornado. Se a solicitação falhar, um código de erro será retornado.	success
Success	string	Indica se o job foi executado com sucesso. true: A execução foi bem-sucedida. false: A execução falhou.	true
Code	string	O código de status HTTP ou um código de erro POP. 2xx: Sucesso. 3xx: Redirecionamento. 4xx: Erro de solicitação. 5xx: Erro de servidor.	200
ErrorCode	string	O código de erro. Este parâmetro é omitido para solicitações bem-sucedidas. Este parâmetro é incluído para solicitações com falha. Para obter mais informações, consulte a seção Códigos de erro deste tópico.
Code	string	O código de status HTTP ou um código de erro POP. 2xx: Sucesso. 3xx: Redirecionamento. 4xx: Erro de solicitação. 5xx: Erro de servidor.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.