Obtient les informations de configuration d'un modèle de tâche.
Testez maintenant
Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.
Test
Autorisation RAM
|
sae:DescribeJob |
get |
*Toutes les ressources.
|
Aucune | Aucune |
Syntaxe de la requête
GET /pop/v1/sam/job/describeJob HTTP/1.1
Paramètres de requête
|
Paramètre |
Type |
Requis |
Description |
Exemple |
| AppId |
string |
Oui |
L'identifiant du modèle de tâche. |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| JobId |
string |
Non |
L'identifiant de la tâche. |
event-b798157b-40a2-4388-b578-71fb897103**-** |
Éléments de réponse
|
Élément |
Type |
Description |
Exemple |
|
object |
Les données de réponse. |
||
| RequestId |
string |
L'identifiant de la requête. |
01CF26C7-00A3-4AA6-BA76-7E95F2A3**** |
| Message |
string |
Les informations supplémentaires sur le résultat de l'appel. |
success |
| TraceId |
string |
L'identifiant de trace, utilisé pour interroger avec précision les informations d'appel. |
ac1a0b2215622246421415014e**** |
| Data |
object |
Les informations du modèle de tâche. |
|
| VpcId |
string |
L'identifiant du VPC. |
vpc-2ze0i263cnn311nvj**** |
| ConfigMapMountDesc |
array<object> |
Les informations du ConfigMap. |
|
|
object |
Les informations du ConfigMap. |
||
| Key |
string |
La clé du ConfigMap. |
k1 |
| ConfigMapName |
string |
Le nom du ConfigMap. |
test |
| MountPath |
string |
Le chemin de montage du conteneur. |
/tmp |
| ConfigMapId |
integer |
L'identifiant du ConfigMap. |
1 |
| SecurityGroupId |
string |
L'identifiant du groupe de sécurité. |
sg-wz969ngg2e49q5i4**** |
| Jdk |
string |
La version JDK requise par le package de déploiement. Valeurs valides :
Ce paramètre n'est pas pris en charge lorsque PackageType est défini sur Image. |
Open JDK 8 |
| ImageUrl |
string |
L'adresse de l'image. Ce paramètre est requis lorsque PackageType est défini sur Image. |
docker.io/library/nginx:1.14.2 |
| SlsConfigs |
string |
La configuration pour la collecte des journaux vers Simple Log Service (SLS).
Descriptions des paramètres :
Si la configuration de collecte SLS reste inchangée lors de déploiements multiples, vous n'avez pas besoin de définir ce paramètre (c'est-à-dire que le champ SlsConfigs n'est pas requis dans la requête). Si vous n'avez plus besoin de la fonctionnalité de collecte SLS, vous devez définir la valeur de ce champ sur une chaîne vide (c'est-à-dire définir SlsConfigs sur "") dans la requête. |
[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}] |
| Tags |
array<object> |
Les informations de balise. |
|
|
object |
Les informations de balise. |
||
| Key |
string |
La clé de la balise. |
k1 |
| Value |
string |
La valeur de la balise. |
v1 |
| PackageUrl |
string |
L'URL du package de déploiement. Ce paramètre est requis lorsque PackageType est défini sur 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 |
Le type de package de tâche. Valeurs valides :
|
War |
| PreStop |
string |
Le script à exécuter avant l'arrêt du conteneur. Un script est déclenché et exécuté avant la suppression du conteneur. Format : |
{"exec":{"command":["cat","/etc/group"]}} |
| PackageVersion |
string |
Le numéro de version du package de déploiement. Ce paramètre est requis lorsque PackageType est défini sur FatJar ou War. |
1.0 |
| JarStartArgs |
string |
Les paramètres de démarrage pour la tâche de package JAR. Commande de démarrage de tâche par défaut : |
start |
| AppName |
string |
Le nom du modèle de tâche. |
demo-app |
| AppId |
string |
L'identifiant du modèle de tâche. |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| JarStartOptions |
string |
Les options de démarrage pour la tâche de package JAR. Commande de démarrage de tâche par défaut : |
-Dtest=true |
| Replicas |
integer |
Le nombre d'instances de tâche. |
2 |
| Memory |
integer |
La mémoire requise pour chaque instance. Unité : Mo. La valeur ne peut pas être 0. La mémoire a une correspondance un à un avec le CPU. Seules les spécifications définies suivantes sont prises en charge :
|
2048 |
| PhpConfig |
string |
Le contenu du fichier de configuration PHP. |
k1=v1 |
| PhpConfigLocation |
string |
Le chemin de montage de la configuration de démarrage de la tâche PHP. Vous devez vous assurer que le serveur PHP utilise ce fichier de configuration pour démarrer. |
/usr/local/etc/php/php.ini |
| PostStart |
string |
Le script à exécuter après le démarrage du conteneur. Un script est déclenché et exécuté immédiatement après la création du conteneur. Format : |
{"exec":{"command":["cat","/etc/group"]}} |
| TerminationGracePeriodSeconds |
integer |
Le délai d'attente d'arrêt progressif. Valeur par défaut : 30. Unité : secondes. Valeurs valides : 1 à 300. |
10 |
| CommandArgs |
string |
Les paramètres pour la commande de démarrage de l'image. Ce sont les paramètres requis par la commande de démarrage Command. Format :
Dans l'exemple du paramètre Command, |
["a","b"] |
| NamespaceId |
string |
L'identifiant de l'espace de noms. |
cn-beijing:test |
| MountHost |
string |
La cible de montage du système de fichiers NAS dans le VPC du modèle de tâche. Si la configuration reste inchangée lors du déploiement, vous n'avez pas besoin de définir ce paramètre (c'est-à-dire que le champ MountHost n'est pas requis dans la requête). Si vous devez effacer la configuration NAS, vous devez définir la valeur de ce champ sur une chaîne vide (c'est-à-dire définir MountHost sur "") dans la requête. |
example.com |
| TomcatConfig |
string |
La configuration du fichier Tomcat. Définissez ce paramètre sur "" ou "{}" pour supprimer la configuration :
|
{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true} |
| RegionId |
string |
L'identifiant de la région. |
cn-beijing |
| VSwitchId |
string |
L'identifiant du vSwitch. |
vsw-2ze559r1z1bpwqxwp**** |
| Cpu |
integer |
Le CPU requis pour chaque instance. Unité : millicores. La valeur ne peut pas être 0. Seules les spécifications définies suivantes sont prises en charge :
|
1000 |
| Envs |
string |
Les paramètres de variable d'environnement du conteneur. Vous pouvez personnaliser les variables d'environnement ou référencer des ConfigMaps. Pour référencer un ConfigMap, créez d'abord une instance ConfigMap. Pour plus d'informations, voir CreateConfigMap. Valeurs valides :
|
[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}] |
| MountDesc |
array<object> |
La description du montage. |
|
|
object |
La description du montage. |
||
| MountPath |
string |
Le chemin de montage du conteneur. |
/tmp |
| NasPath |
string |
Le répertoire de fichiers relatif du système de fichiers NAS. |
/ |
| CustomHostAlias |
string |
Le mappage d'hôte personnalisé dans le conteneur. Valeurs valides :
|
[{"hostName":"test.host.name","ip":"0.0.0.0"}] |
| WebContainer |
string |
La version Tomcat requise par le package de déploiement. Valeurs valides :
Ce paramètre n'est pas pris en charge lorsque PackageType est défini sur Image. |
apache-tomcat-7.0.91 |
| Command |
string |
La commande de démarrage de l'image. La commande doit être un objet exécutable qui existe dans le conteneur. Exemple :
Sur la base de l'exemple précédent, |
echo |
| WarStartOptions |
string |
Les options de démarrage pour la tâche de package WAR. Commande de démarrage de tâche par défaut : |
custom-option |
| NasId |
string |
L'identifiant du NAS. |
AKSN89** |
| OssAkId |
string |
L'identifiant AccessKey pour les opérations de lecture et d'écriture OSS. |
xxxxxx |
| OssAkSecret |
string |
Le secret AccessKey pour les opérations de lecture et d'écriture OSS. |
xxxxxx |
| OssMountDescs |
array<object> |
La description du montage OSS. |
|
|
object |
La description du montage OSS. |
||
| bucketName |
string |
Le nom du bucket. |
oss-bucket |
| bucketPath |
string |
Le répertoire ou l'objet OSS que vous avez créé dans OSS. Si le répertoire de montage OSS n'existe pas, une exception est déclenchée. |
data/user.data |
| mountPath |
string |
Le chemin du conteneur dans SAE. Si le chemin existe déjà, le chemin existant est écrasé. Si le chemin n'existe pas, un nouveau chemin est créé. |
/usr/data/user.data |
| readOnly |
boolean |
Indique si le chemin du conteneur dispose des permissions de lecture sur les ressources du répertoire de montage. Valeurs valides :
|
true |
| EdasContainerVersion |
string |
La version de l'environnement d'exécution de la tâche dans le framework HSF, telle que le conteneur Ali-Tomcat. |
3.5.3 |
| Timezone |
string |
Le fuseau horaire. Valeur par défaut : Asia/Shanghai. |
Asia/Shanghai |
| AppDescription |
string |
La description du modèle de tâche. |
Sample application |
| AcrInstanceId |
string |
L'identifiant de l'instance ACR Enterprise. |
cri-xxxxxx |
| AcrAssumeRoleArn |
string |
L'ARN du rôle RAM requis pour extraire des images entre comptes. Pour plus d'informations, voir Extraire des images Alibaba Cloud entre comptes et Implémenter l'autorisation entre comptes à l'aide de rôles RAM. |
acs:ram::123456789012****:role/adminrole |
| ImagePullSecrets |
string |
L'identifiant du secret correspondant. |
10 |
| TriggerConfig |
string |
La configuration du déclencheur de tâche. Configurez ce paramètre en fonction du type de tâche.
|
{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"} |
| ConcurrencyPolicy |
string |
La stratégie de concurrence des tâches. Valeurs valides :
|
Allow |
| Suspend |
boolean |
Indique si le modèle de tâche doit être suspendu. |
false |
| Timeout |
integer |
Le délai d'expiration de la tâche. Unité : secondes. |
3600 |
| BackoffLimit |
integer |
Le nombre de tentatives de la tâche. |
3 |
| Slice |
boolean |
Indique si le découpage de tâche doit être activé. |
true |
| SliceEnvs |
string |
Les paramètres de découpage de tâche. |
SliceEnvs |
| RefAppId |
string |
L'identifiant du modèle de tâche référencé. |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| RefedAppIds |
array |
La liste des identifiants des cibles de tâche référencées. |
|
|
string |
L'identifiant du modèle de tâche. |
8621a6ca-d1cd-4928-8642-7d5cfe69**** |
|
| PublicWebHookUrls |
array |
La liste des URL de requête publiques pour la tâche ponctuelle. |
|
|
string |
L'URL publique. |
http://***/webhook/putEvents?token=*** |
|
| VpcWebHookUrls |
array |
La liste des URL de requête internes pour les tâches ponctuelles. |
|
|
string |
L'URL interne. |
http://***/webhook/putEvents?token=*** |
|
| ProgrammingLanguage |
string |
Le langage de programmation de la pile technologique utilisée pour créer le modèle de tâche. Valeurs valides :
|
java |
| NasConfigs |
string |
La configuration pour le montage 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 |
L'environnement Python. Python 3.9.15 est pris en charge. |
PYTHON 3.9.15 |
| PythonModules |
string |
Les dépendances de modules pour une installation personnalisée. Par défaut, les dépendances définies dans le fichier requirements.txt du dossier racine sont installées. Si aucun package personnalisé n'est configuré, vous pouvez spécifier les dépendances à installer. |
Flask==2.0 |
| BestEffortType |
string |
La stratégie de meilleur effort. |
besteffort |
| ErrorCode |
string |
Le code d'erreur.
|
InvalidAppId.NotFound |
| Code |
string |
Le code d'état de l'API ou le code d'erreur POP. Valeurs valides :
|
200 |
| Success |
boolean |
Indique si la configuration du modèle de tâche a été récupérée avec succès. Valeurs valides :
|
true |
Exemples
JSON format
{
"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": "Application d'exemple",
"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": "besteffort"
},
"ErrorCode": "InvalidAppId.NotFound",
"Code": "200",
"Success": true
}
Codes d'erreur
|
Code de statut HTTP |
Code d'erreur |
Message d'erreur |
Description |
|---|---|---|---|
| 404 | InvalidAppId.NotFound | The specified AppId does not exist. | L'AppId spécifié n'existe pas. |
Consultez Codes d'erreur pour la liste complète.
Notes de version
Consultez Notes de version pour la liste complète.