Todos os produtos
Search
Central de documentação

Serverless App Engine:DescribeJob

Última atualização: Jun 28, 2026

Chama a API DescribeJob para obter a configuração do modelo de tarefa.

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

get

*All Resource

*

Nenhuma Nenhuma

Sintaxe da solicitação

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

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

AppId

string

Sim

O ID do modelo de tarefa.

7171a6ca-d1cd-4928-8642-7d5cfe69****

JobId

string

Não

O ID da tarefa.

event-b798157b-40a2-4388-b578-71fb897103**-**

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Os dados retornados.

RequestId

string

O ID da solicitação.

01CF26C7-00A3-4AA6-BA76-7E95F2A3****

Message

string

Informações adicionais sobre o resultado da chamada.

success

TraceId

string

O ID de rastreamento usado para consultar os detalhes de uma solicitação.

ac1a0b2215622246421415014e****

Data

object

As informações do modelo de tarefa.

VpcId

string

O ID da VPC.

vpc-2ze0i263cnn311nvj****

ConfigMapMountDesc

array<object>

As informações sobre o ConfigMap montado.

object

As informações do ConfigMap.

Key

string

The key of the key-value pair in the ConfigMap.

k1

ConfigMapName

string

The name of the ConfigMap.

test

MountPath

string

The container mount path.

/tmp

ConfigMapId

integer

The ConfigMap ID.

1

SecurityGroupId

string

O ID do grupo de segurança.

sg-wz969ngg2e49q5i4****

Jdk

string

A versão do JDK exigida pelo pacote de implantação. As seguintes versões são suportadas:

  • Open JDK 8

  • Open JDK 7

  • Dragonwell 11

  • Dragonwell 8

  • openjdk-8u191-jdk-alpine3.9

  • openjdk-7u201-jdk-alpine3.9

Este parâmetro não é aplicável se Package Type estiver definido como Image.

Open JDK 8

ImageUrl

string

A URL da imagem. Este parâmetro é obrigatório se Package Type estiver definido como Image.

docker.io/library/nginx:1.14.2

SlsConfigs

string

A configuração para coleta de logs no Log Service (SLS).

  • Use um recurso SLS criado automaticamente pelo SAE: [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}].

  • Use um recurso SLS personalizado: [{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}].

Os parâmetros são descritos da seguinte forma:

  • projectName: O nome do projeto SLS.

  • logDir: O caminho do log.

  • logType: O tipo de log. stdout especifica os logs de saída padrão do contêiner. Você pode especificar apenas um log do tipo stdout. Se este parâmetro for omitido, os logs de arquivo serão coletados.

  • logstoreName: O nome do Logstore no SLS.

  • logtailName: O nome da configuração do Logtail no SLS. Se você não especificar este parâmetro, uma nova configuração do Logtail será criada.

Você pode omitir este parâmetro se a configuração do Log Service não for alterada durante a nova implantação. Para desativar a coleta de logs, defina este parâmetro como uma string vazia ("").

[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]

Tags

array<object>

As tags do modelo de tarefa.

object

As informações da tag.

Key

string

The tag key.

k1

Value

string

The tag value.

v1

PackageUrl

string

A URL do pacote. Este parâmetro é obrigatório se Package Type estiver definido como FatJar ou War.

https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war

PackageType

string

O tipo do pacote de tarefa. Valores válidos:

  • Para implantações Java, FatJar, War e Image são suportados.

  • Para implantações PHP, os seguintes tipos de pacote são suportados:

    • PhpZip

    • IMAGE_PHP_5_4

    • IMAGE_PHP_5_4_ALPINE

    • IMAGE_PHP_5_5

    • IMAGE_PHP_5_5_ALPINE

    • IMAGE_PHP_5_6

    • IMAGE_PHP_5_6_ALPINE

    • IMAGE_PHP_7_0

    • IMAGE_PHP_7_0_ALPINE

    • IMAGE_PHP_7_1

    • IMAGE_PHP_7_1_ALPINE

    • IMAGE_PHP_7_2

    • IMAGE_PHP_7_2_ALPINE

    • IMAGE_PHP_7_3

    • IMAGE_PHP_7_3_ALPINE

  • Para implantações Python, PythonZip e Image são suportados.

War

PreStop

string

O script a ser executado antes que o contêiner pare. Este script é executado antes que o sistema exclua o contêiner. Exemplo: {"exec":{"command":["cat","/etc/group"]}}

{"exec":{"command":["cat","/etc/group"]}}

PackageVersion

string

A versão do pacote. Este parâmetro é obrigatório se Package Type estiver definido como FatJar ou War.

1.0

JarStartArgs

string

Os argumentos para a inicialização de um pacote JAR. O comando de inicialização padrão é $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

start

AppName

string

O nome do modelo de tarefa.

demo-app

AppId

string

O ID do modelo de tarefa.

7171a6ca-d1cd-4928-8642-7d5cfe69****

JarStartOptions

string

As opções para a inicialização de um pacote JAR. O comando de inicialização padrão é $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs.

-Dtest=true

Replicas

integer

O número de instâncias de tarefa.

2

Memory

integer

A memória exigida por cada instância, em MB. Este valor não pode ser 0. Os recursos de CPU e memória são alocados em proporções fixas. As seguintes combinações são suportadas:

  • 1024: corresponde a 500 e 1.000 milicores.

  • 2048: corresponde a 500, 1.000 e 2.000 milicores.

  • 4096: corresponde a 1.000, 2.000 e 4.000 milicores.

  • 8192: corresponde a 2.000, 4.000 e 8.000 milicores.

  • 12288: corresponde a 12.000 milicores.

  • 16384: corresponde a 4.000, 8.000 e 16.000 milicores.

  • 24576: corresponde a 12.000 milicores.

  • 32768: corresponde a 16.000 milicores.

  • 65536: corresponde a 8.000, 16.000 e 32.000 milicores.

  • 131072: corresponde a 32.000 milicores.

2048

PhpConfig

string

O conteúdo do arquivo de configuração do PHP.

k1=v1

PhpConfigLocation

string

O caminho de montagem da configuração de inicialização da tarefa PHP. Certifique-se de que o servidor PHP use esta configuração para iniciar.

/usr/local/etc/php/php.ini

PostStart

string

O script a ser executado após a inicialização do contêiner. Este script é executado imediatamente após o sistema criar o contêiner. Exemplo: {"exec":{"command":["cat","/etc/group"]}}

{"exec":{"command":["cat","/etc/group"]}}

TerminationGracePeriodSeconds

integer

O tempo limite para uma parada graceful, em segundos. Padrão: 30. Valores válidos: 1 a 300.

10

CommandArgs

string

Os argumentos do comando de inicialização da imagem. Os argumentos são passados para o parâmetro Command. Formato:

["a","b"]

No exemplo do parâmetro Command, CommandArgs=["abc", ">", "file0"]. Neste caso, ["abc", ">", "file0"] deve ser convertido em uma string no formato de uma matriz JSON. Se este parâmetro não for especificado, você não precisa configurá-lo.

["a","b"]

NamespaceId

string

O ID do namespace.

cn-beijing:test

MountHost

string

O destino de montagem do sistema de arquivos Apsara File Storage NAS na VPC do modelo de tarefa. Você pode omitir este parâmetro se a configuração do NAS não for alterada durante a nova implantação. Para limpar a configuração do NAS, defina este parâmetro como uma string vazia ("").

example.com

TomcatConfig

string

A configuração do arquivo Tomcat. Para excluir a configuração, defina este parâmetro como "" ou "{}".

  • port: O número da porta. Valores válidos: 1024 a 65535. As portas abaixo de 1024 são reservadas. Se você não especificar uma porta, o valor padrão é 8080.

  • contextPath: O caminho de acesso. Valor padrão: /.

  • maxThreads: O número máximo de conexões no pool de conexões. Valor padrão: 400.

  • uriEncoding: O esquema de codificação URI para o Tomcat. Valores válidos: UTF-8, ISO-8859-1, GBK e GB2312. Se você não especificar este parâmetro, o valor padrão ISO-8859-1 será usado.

  • useBodyEncodingForUri: Especifica se deve ser usada a codificação de caracteres do corpo da solicitação para o URI. Valor padrão: true.

{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true}

RegionId

string

O ID da região.

cn-beijing

VSwitchId

string

O ID do vSwitch.

vsw-2ze559r1z1bpwqxwp****

Cpu

integer

O número de núcleos de CPU exigidos por cada instância. Unidade: milicores. Este parâmetro não pode ser definido como 0. Apenas as seguintes especificações fixas são suportadas:

  • 500

  • 1000

  • 2000

  • 4000

  • 8000

  • 16000

  • 32000

1000

Envs

string

As variáveis de ambiente do contêiner. Você pode definir variáveis personalizadas ou referenciar um ConfigMap. Para referenciar um ConfigMap, você deve primeiro criar um ConfigMap. Para mais informações, consulte CreateConfigMap. Os seguintes formatos são suportados:

  • Definir variáveis personalizadas

    • 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, insira sae-sys-configmap-all-<ConfigMap name>, por 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 do par chave-valor. Se você referenciar todas as chaves no ConfigMap, não precisará especificar este parâmetro.

[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]

MountDesc

array<object>

A descrição da montagem.

object

A descrição da montagem.

MountPath

string

The container mount path.

/tmp

NasPath

string

The directory in the Apsara File Storage NAS file system.

/

CustomHostAlias

string

O mapeamento de host personalizado no contêiner. Os parâmetros são descritos da seguinte forma:

  • hostName: O nome de domínio ou nome de host.

  • ip: O endereço IP.

[{"hostName":"test.host.name","ip":"0.0.0.0"}]

WebContainer

string

A versão do contêiner Tomcat da qual o pacote depende. As seguintes versões são suportadas:

  • apache-tomcat-7.0.91

  • apache-tomcat-8.5.42

Este parâmetro não é suportado quando Package Type está definido como Image.

apache-tomcat-7.0.91

Command

string

O comando de inicialização da imagem. O comando deve ser um executável que exista no contêiner. Exemplo:

command:
      - echo
      - abc
      - >
      - file0

Neste exemplo, Command="echo", CommandArgs=["abc", ">", "file0"].

echo

WarStartOptions

string

As opções para a inicialização de um pacote WAR. O comando de inicialização padrão é java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start.

custom-option

NasId

string

O ID do sistema de arquivos Apsara File Storage NAS.

AKSN89**

OssAkId

string

O AccessKey ID para acessar buckets do Object Storage Service (OSS).

xxxxxx

OssAkSecret

string

O AccessKey secret para acessar buckets do OSS.

xxxxxx

OssMountDescs

array<object>

A descrição do bucket do OSS montado.

object

A descrição do bucket do OSS montado.

bucketName

string

The bucket name.

oss-bucket

bucketPath

string

The directory or object that you created in the OSS bucket. An exception is returned if the specified mount directory does not exist.

data/user.data

mountPath

string

The path in your SAE container. If the path exists, it is overwritten. If the path does not exist, a new path is created.

/usr/data/user.data

readOnly

boolean

Specifies whether the container has read-only access to the mounted resources. Valid values:

  • true: The path has read-only permissions.

  • false: The path has read and write permissions.

true

EdasContainerVersion

string

A versão do ambiente de execução no framework HSF, como um contêiner Ali-Tomcat.

3.5.3

Timezone

string

O fuso horário. Valor padrão: Asia/Shanghai.

Asia/Shanghai

AppDescription

string

A descrição do modelo de tarefa.

Sample application

AcrInstanceId

string

O ID da instância do Container Registry (ACR) Enterprise Edition.

cri-xxxxxx

AcrAssumeRoleArn

string

O ARN da função RAM necessária para realizar pull de imagens entre contas. Para mais informações, consulte Pull images across Alibaba Cloud accounts e Grant permissions across Alibaba Cloud accounts by using a RAM role.

acs:ram::123456789012****:role/adminrole

ImagePullSecrets

string

O ID do Secret.

10

TriggerConfig

string

A configuração do gatilho de tarefa. A configuração varia com base no tipo de tarefa.

  • Tarefa agendada: Defina type como time, config como uma expressão Cron e timezone como um fuso horário específico. Exemplo: {"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

  • Tarefa única: Defina type como http e, para config, especifique as regras de gatilho HTTP. Para mais informações, consulte SourceHttpEventParameters. Exemplo: {"type":"http","config":{"type":"HTTPS","method":["GET"],"ip":[],"referer":[],"securityConfig":"none"}}

{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

ConcurrencyPolicy

string

A política de simultaneidade para a tarefa. Valores válidos:

  • Forbid: Proíbe execuções simultâneas. Uma nova tarefa não é criada se a anterior não tiver sido concluída.

  • Allow: Permite execuções simultâneas.

  • Replace: Se a tarefa anterior não tiver sido concluída, a nova tarefa a substituirá.

Allow

Suspend

boolean

Especifica se o modelo de tarefa deve ser suspenso.

false

Timeout

integer

O período de tempo limite para a tarefa. Unidade: segundos.

3600

BackoffLimit

integer

O número máximo de tentativas para uma tarefa com falha.

3

Slice

boolean

Especifica se o sharding de tarefa deve ser ativado.

true

SliceEnvs

string

Os parâmetros para o sharding de tarefa.

SliceEnvs

RefAppId

string

O ID do modelo de tarefa referenciado.

7171a6ca-d1cd-4928-8642-7d5cfe69****

RefedAppIds

array

Os IDs dos modelos de tarefa que referenciam este modelo.

string

O ID do modelo de tarefa.

8621a6ca-d1cd-4928-8642-7d5cfe69****

PublicWebHookUrls

array

A lista de URLs de solicitação públicas para a tarefa única.

string

A URL pública.

http://***/webhook/putEvents?token=***

VpcWebHookUrls

array

A lista de URLs de solicitação privadas para a tarefa única.

string

A URL privada.

http://***/webhook/putEvents?token=***

ProgrammingLanguage

string

A linguagem de programação usada para o modelo de tarefa. Valores válidos:

  • java: Java

  • php: PHP

  • python: Python

  • other: Outras linguagens, como C++, Go, .NET e Node.js.

java

NasConfigs

string

A configuração para montar um sistema de arquivos Apsara File Storage NAS.

[{"mountPath":"/test1","readOnly":false,"nasId":"nasId1","mountDomain":"nasId1.cn-shenzhen.nas.aliyuncs.com","nasPath":"/test1"},{"nasId":"nasId2","mountDomain":"nasId2.cn-shenzhen.nas.aliyuncs.com","readOnly":false,"nasPath":"/test2","mountPath":"/test2"}]

Python

string

O ambiente Python. O PYTHON 3.9.15 é suportado.

PYTHON 3.9.15

PythonModules

string

As dependências de módulo Python a serem instaladas. Por padrão, o SAE instala dependências de um arquivo requirements.txt no diretório raiz do pacote. Use este parâmetro para especificar dependências se um arquivo requirements.txt não estiver presente ou para adicionar módulos extras.

Flask==2.0

BestEffortType

string

A política Best-Effort.

ErrorCode

string

O código de erro.

  • O parâmetro ErrorCode é retornado apenas se a solicitação falhar.

  • Para obter uma lista de possíveis valores de ErrorCode, consulte a seção Códigos de erro neste tópico.

Code

string

O código de status HTTP ou código de erro POP. Valores válidos:

  • 2xx: A solicitação foi bem-sucedida.

  • 3xx: A solicitação foi redirecionada.

  • 4xx: Ocorreu um erro de solicitação.

  • 5xx: Ocorreu um erro de servidor.

200

Success

boolean

Indica se a solicitação foi bem-sucedida. Valores válidos:

  • true: A solicitação foi bem-sucedida.

  • false: A solicitação falhou.

true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3****",
  "Message": "success",
  "TraceId": "ac1a0b2215622246421415014e****",
  "Data": {
    "VpcId": "vpc-2ze0i263cnn311nvj****",
    "ConfigMapMountDesc": [
      {
        "Key": "k1",
        "ConfigMapName": "test",
        "MountPath": "/tmp",
        "ConfigMapId": 1
      }
    ],
    "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
    "Jdk": "Open JDK 8",
    "ImageUrl": "docker.io/library/nginx:1.14.2",
    "SlsConfigs": "[{\"logDir\":\"\",\"logType\":\"stdout\"},{\"logDir\":\"/tmp/a.log\"}]",
    "Tags": [
      {
        "Key": "k1",
        "Value": "v1"
      }
    ],
    "PackageUrl": "https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war",
    "PackageType": "War",
    "PreStop": "{\"exec\":{\"command\":[\"cat\",\"/etc/group\"]}}",
    "PackageVersion": "1.0",
    "JarStartArgs": "start",
    "AppName": "demo-app",
    "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
    "JarStartOptions": "-Dtest=true",
    "Replicas": 2,
    "Memory": 2048,
    "PhpConfig": "k1=v1",
    "PhpConfigLocation": "/usr/local/etc/php/php.ini",
    "PostStart": "{\"exec\":{\"command\":[\"cat\",\"/etc/group\"]}}",
    "TerminationGracePeriodSeconds": 10,
    "CommandArgs": "[\"a\",\"b\"]",
    "NamespaceId": "cn-beijing:test",
    "MountHost": "example.com",
    "TomcatConfig": "{\"port\":8080,\"contextPath\":\"/\",\"maxThreads\":400,\"uriEncoding\":\"ISO-8859-1\",\"useBodyEncodingForUri\":true}",
    "RegionId": "cn-beijing",
    "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
    "Cpu": 1000,
    "Envs": "[{\"name\":\"TEST_ENV_KEY\",\"value\":\"TEST_ENV_VAR\"}]",
    "MountDesc": [
      {
        "MountPath": "/tmp",
        "NasPath": "/"
      }
    ],
    "CustomHostAlias": "[{\"hostName\":\"test.host.name\",\"ip\":\"0.0.0.0\"}]",
    "WebContainer": "apache-tomcat-7.0.91",
    "Command": "echo",
    "WarStartOptions": "custom-option",
    "NasId": "AKSN89**",
    "OssAkId": "xxxxxx",
    "OssAkSecret": "xxxxxx",
    "OssMountDescs": [
      {
        "bucketName": "oss-bucket",
        "bucketPath": "data/user.data",
        "mountPath": "/usr/data/user.data",
        "readOnly": true
      }
    ],
    "EdasContainerVersion": "3.5.3",
    "Timezone": "Asia/Shanghai",
    "AppDescription": "Sample application",
    "AcrInstanceId": "cri-xxxxxx",
    "AcrAssumeRoleArn": "acs:ram::123456789012****:role/adminrole",
    "ImagePullSecrets": "10",
    "TriggerConfig": "{\"type\":\"time\",\"config\":\"0 1 */1 * ?\",\"timezone\":\"GMT+8:00\"}",
    "ConcurrencyPolicy": "Allow",
    "Suspend": false,
    "Timeout": 3600,
    "BackoffLimit": 3,
    "Slice": true,
    "SliceEnvs": "SliceEnvs",
    "RefAppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
    "RefedAppIds": [
      "8621a6ca-d1cd-4928-8642-7d5cfe69****"
    ],
    "PublicWebHookUrls": [
      "http://***/webhook/putEvents?token=***"
    ],
    "VpcWebHookUrls": [
      "http://***/webhook/putEvents?token=***"
    ],
    "ProgrammingLanguage": "java",
    "NasConfigs": "[{\"mountPath\":\"/test1\",\"readOnly\":false,\"nasId\":\"nasId1\",\"mountDomain\":\"nasId1.cn-shenzhen.nas.aliyuncs.com\",\"nasPath\":\"/test1\"},{\"nasId\":\"nasId2\",\"mountDomain\":\"nasId2.cn-shenzhen.nas.aliyuncs.com\",\"readOnly\":false,\"nasPath\":\"/test2\",\"mountPath\":\"/test2\"}]",
    "Python": "PYTHON 3.9.15",
    "PythonModules": "Flask==2.0",
    "BestEffortType": ""
  },
  "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.