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

Obtém uma lista de modelos de 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:ListJobs

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CurrentPage	integer	Não	O número da página. O valor começa em 1.	1
PageSize	integer	Não	O número de entradas por página. Valores válidos: 0 a 200.	20
AppName	string	Não	O nome do modelo de job.	demo-app
NamespaceId	string	Não	O ID do namespace.	cn-beijing:demo
Tags	string	Não	Uma lista de tags. Esta é uma string JSON. O valor consiste nas seguintes partes: key: A chave da tag. value: O valor da tag.	[{"key":"key","value":"value"}]
OrderBy	string	Não	O método de classificação para os modelos de job. Valores válidos: running: Classifica pelo número de instâncias em execução. instances: Classifica pelo número de instâncias de destino.	running
Reverse	boolean	Não	Especifica se os resultados devem ser classificados em ordem crescente ou decrescente com base no campo especificado pelo parâmetro OrderBy. Valores válidos: true: ordem crescente. false: ordem decrescente.	true
FieldType	string	Não	A dimensão pela qual filtrar os modelos de job. Valores válidos: appName: O nome do modelo de job. appIds: O ID do modelo de job.	appName
FieldValue	string	Não	O nome ou ID do modelo de job de destino. Este valor corresponde à dimensão especificada por FieldType.	demo-app
Workload	string	Não	A carga de trabalho. Defina o valor como `job`.	job

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
Message	string	Informações adicionais sobre a chamada.	success
RequestId	string	O ID da solicitação.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	A lista de modelos de job.
CurrentPage	integer	O número da página atual.	1
TotalSize	integer	O número total de modelos de job.	2
PageSize	integer	O número de entradas por página.	20
Applications	array<object>	A lista de modelos de job.
	array<object>	Os detalhes do modelo de job.
AppName	string	The name of the job template.	demo-app
NamespaceId	string	The namespace ID.	cn-beijing:demo
AppId	string	The ID of the job template.	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	The tags of the job template.
	object	The details of the job template tag.
Key	string	The tag key.	key
Value	string	The tag value.	value
RegionId	string	The region ID.	cn-beijing
AppDescription	string	The description of the job template.	description
TriggerConfig	string	The trigger configuration of the job. The configuration varies based on the job type. Scheduled task: Set the type field to time, the config field to a Cron expression, and the timezone field to a specific time zone. Example: `{"type":"time","config":"0 1 /1 ?","timezone":"GMT+8:00"}` One-time job: Set the type field to http and configure the HTTP trigger rule in the config field. For more information, see Request parameter SourceHttpEventParameters. Example: `{"type":"http","config":{"type":"HTTPS","method":["GET"],"ip":[],"referer":[],"securityConfig":"none"}}`	{"type":"time","config":"0 1 /1 ?","timezone":"GMT+8:00"}
Suspend	boolean	Indicates whether the job template is paused.	false
Active	integer	The number of running instances.	0
Succeeded	integer	The number of successful instances.	3
Failed	integer	The number of failed instances.	0
LastStartTime	integer	The time when the last job was started.	1657522800
CompletionTime	integer	The time when the last job was completed.	1657522839
LastChangeorderState	string	Indicates whether the last release order was successfully executed. Valid values: 0: The release order failed to be executed. 1: The release order was successfully executed.	1
LastJobState	string	The state of the last job. Valid values: 0: Not executed. 1: Successful. 2: Failed. 3: Running.	0
Cpu	integer	The CPU required for each instance, in millicores. The value cannot be 0. Only the following defined specifications are supported: 500 1000 2000 4000 8000 16000 32000	500
Mem	integer	The memory required for each instance, in MB. The value cannot be 0. This parameter corresponds to the CPU parameter. Only the following defined specifications are supported: 1024: corresponds to 500 and 1,000 millicores of CPU. 2048: corresponds to 500, 1,000, and 2,000 millicores of CPU. 4096: corresponds to 1,000, 2,000, and 4,000 millicores of CPU. 8192: corresponds to 2,000, 4,000, and 8,000 millicores of CPU. 12288: corresponds to 12,000 millicores of CPU. 16384: corresponds to 4,000, 8,000, and 16,000 millicores of CPU. 24576: corresponds to 12,000 millicores of CPU. 32768: corresponds to 16,000 millicores of CPU. 65536: corresponds to 8,000, 16,000, and 32,000 millicores of CPU. 131072: corresponds to 32,000 millicores of CPU.	1024
Message	string	Additional information about the call.	success
ImageUrl	string	The image URL.
ErrorCode	string	O código de erro. Se a solicitação for bem-sucedida, este parâmetro não será retornado. Se a solicitação falhar, este parâmetro será retornado. Para mais informações, consulte a seção Códigos de erro deste tópico.
Code	string	O status da interface ou o código de erro POP. Valores válidos: 2xx: A solicitação foi bem-sucedida. 3xx: Redirecionamento. 4xx: Ocorreu um erro de solicitação. 5xx: Ocorreu um erro de servidor.	200
Success	boolean	Indica se a lista de modelos de job foi obtida. Valores válidos: true: A lista foi obtida. false: Falha ao obter a lista.	true
CurrentPage	integer	O número da página atual.	1
TotalSize	integer	O número total de modelos de job.	2
PageSize	integer	O número de entradas por página.	20

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 2,
    "PageSize": 20,
    "Applications": [
      {
        "AppName": "demo-app",
        "NamespaceId": "cn-beijing:demo",
        "AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "RegionId": "cn-beijing",
        "AppDescription": "description",
        "TriggerConfig": "{\"type\":\"time\",\"config\":\"0 1 */1 * ?\",\"timezone\":\"GMT+8:00\"}",
        "Suspend": false,
        "Active": 0,
        "Succeeded": 3,
        "Failed": 0,
        "LastStartTime": 1657522800,
        "CompletionTime": 1657522839,
        "LastChangeorderState": "1",
        "LastJobState": "0",
        "Cpu": 500,
        "Mem": 1024,
        "Message": "success",
        "ImageUrl": ""
      }
    ]
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

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.