Chama a API DescribeJob para obter a configuração do modelo de tarefa.
Experimente agora
Testar
Autorização RAM
|
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:
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).
Os parâmetros são descritos da seguinte forma:
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:
|
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"]}} |
| 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 é |
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 é |
-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:
|
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"]}} |
| 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:
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":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:
|
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:
|
[{"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":"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:
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:
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 é |
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 |
| 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.
|
{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"} |
| ConcurrencyPolicy |
string |
A política de simultaneidade para a tarefa. Valores válidos:
|
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 |
| 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 |
Flask==2.0 |
| BestEffortType |
string |
A política Best-Effort. |
|
| ErrorCode |
string |
O código de erro.
|
|
| Code |
string |
O código de status HTTP ou código de erro POP. Valores válidos:
|
200 |
| Success |
boolean |
Indica se a solicitação foi bem-sucedida. Valores válidos:
|
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.