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

Consulta as informações sobre jobs.

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

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /pop/v1/sam/job/describeJobHistory 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.	e1a7a07-abcb-4652-a1d3-2d57f415****
CurrentPage	integer	Não	O número da página a ser retornada.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 0 a 10000.	20
State	string	Não	O status do job. Valores válidos: 0: O job não é executado. 1: O job é executado. 2: O job falha ao ser executado. 3: O job está sendo executado.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação.	53F15A18-8079-5992-810C-0211A5AE****
Message	string	A mensagem retornada. Observe as seguintes regras: Se a chamada for bem-sucedida, success será retornado. Se a chamada falhar, um código de erro será retornado.	success
TraceId	string	O ID de rastreamento usado para consultar os detalhes da solicitação.	0b1639af16575057857241351e****
Data	object	Os dados retornados.
CurrentPage	integer	O número da página retornada.	1
TotalSize	integer	O número total de jobs.	20
PageSize	integer	O número de entradas a serem retornadas em cada página. Valores válidos: 0 a 10000.	20
Jobs	array<object>	Os jobs.
	object
JobId	string	The job ID.	manual-3db7a8fa-5d40-4edc-92e4-49d50eab****
Active	integer	The number of running instances.	0
Succeeded	integer	The number of instances that are successfully run.	3
Failed	integer	The number of instances that failed to run.	0
StartTime	integer	The time when the job was created.	1657522800
CompletionTime	integer	The time when the job was executed.	1657522839
Message	string	The message returned if exceptions occur during job running.
State	string	The status of the job. Valid values: 0: The job was not executed. 1: The job was executed. 2: The job failed to be executed. 3: The job is being executed.	1
ErrorCode	string	O código de erro retornado. Observe as seguintes regras: Se a chamada for bem-sucedida, o parâmetro ErrorCode não será retornado. Se a chamada falhar, o parâmetro ErrorCode será retornado. Para mais informações, consulte a seção "Códigos de erro" neste tópico.
Code	string	O código de status HTTP retornado. Valores válidos: 2xx: A chamada foi bem-sucedida. 3xx: A chamada foi redirecionada. 4xx: A chamada falhou. 5xx: Ocorreu um erro de servidor.	200
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true false	true

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	InvalidAppId.NotFound	The specified AppId does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.