ListJobs - - Centre de documentation Alibaba Cloud

Consulte la liste des modèles 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

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

sae:ListJobs

list

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

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

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
CurrentPage	integer	Non	Le numéro de la page actuelle. Les valeurs valides commencent à 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 0 à 200.	20
AppName	string	Non	Le nom du modèle de tâche.	demo-app
NamespaceId	string	Non	L'identifiant de l'espace de noms.	cn-beijing:demo
Tags	string	Non	La liste des balises. La valeur est une chaîne JSON qui contient les champs suivants : key : la clé de la balise value : la valeur de la balise	[{"key":"key","value":"value"}]
OrderBy	string	Non	Le champ utilisé pour trier les modèles de tâche. Valeurs valides : running : trier par le nombre actuel d'instances cibles instances : trier par le nombre cible d'instances	running
Reverse	boolean	Non	Indique si l'ordre de tri doit être inversé en fonction du champ spécifié par le paramètre OrderBy. Valeurs valides : true : trier par ordre croissant false : trier par ordre décroissant	true
FieldType	string	Non	La dimension utilisée pour filtrer les modèles de tâche. Valeurs valides : appName : le nom du modèle de tâche appIds : l'identifiant du modèle de tâche	appName
FieldValue	string	Non	La valeur utilisée pour filtrer les modèles de tâche en fonction de la dimension spécifiée par le paramètre FieldType. Saisissez le nom du modèle de tâche ou l'identifiant du modèle de tâche.	demo-app
Workload	string	Non	Le type de charge de travail. Définissez la valeur sur `job`.	job

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de la réponse.
Message	string	Les informations supplémentaires sur le résultat de l'opération.	success
RequestId	string	L'identifiant de la requête.	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	La liste des modèles de tâche.
CurrentPage	integer	Le numéro de la page actuelle.	1
TotalSize	integer	Le nombre total de modèles de tâche.	2
PageSize	integer	Le nombre d'entrées par page.	20
Applications	array<object>	La liste des modèles de tâche.
	array<object>	Les détails du modèle de tâche.
AppName	string	Le nom du modèle de tâche.	demo-app
NamespaceId	string	L'identifiant de l'espace de noms.	cn-beijing:demo
AppId	string	L'identifiant du modèle de tâche.	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	Les balises du modèle de tâche.
	object	Les détails de la balise du modèle de tâche.
Key	string	La clé de la balise.	key
Value	string	La valeur de la balise.	value
RegionId	string	L'identifiant de la région.	cn-beijing
AppDescription	string	La description du modèle de tâche.	description
TriggerConfig	string	La configuration du déclencheur du nœud. Configurez ce paramètre en fonction du type de nœud. Nœud planifié : Définissez le champ type sur time, le champ config sur une expression cron spécifique et le champ timezone sur le fuseau horaire spécifié. Exemple de configuration : `{"type":"time","config":"0 1 /1 ?","timezone":"GMT+8:00"}` Nœud ponctuel : Définissez le champ type sur http et configurez le champ config avec des règles de déclenchement HTTP spécifiques. Pour plus d'informations, consultez la section paramètre de requête SourceHttpEventParameters. Exemple de configuration : `{"type":"http","config":{"type":"HTTPS","method":["GET"],"ip":[],"referer":[],"securityConfig":"none"}}`	{"type":"time","config":"0 1 /1 ?","timezone":"GMT+8:00"}
Suspend	boolean	Indique si le modèle de tâche est en pause.	false
Active	integer	Le nombre d'instances en cours d'exécution.	0
Succeeded	integer	Le nombre d'instances ayant réussi.	3
Failed	integer	Le nombre d'instances ayant échoué.	0
LastStartTime	integer	L'heure de début de la dernière tâche.	1657522800
CompletionTime	integer	L'heure de fin de la dernière tâche.	1657522839
LastChangeorderState	string	Indique si le dernier ordre de modification a été exécuté avec succès. Valeurs valides : 0 : L'ordre de modification a échoué. 1 : L'ordre de modification a réussi.	1
LastJobState	string	L'état d'exécution de la dernière tâche. Valeurs valides : 0 : non exécutée 1 : exécutée avec succès 2 : échec de l'exécution 3 : en cours d'exécution	0
Cpu	integer	Le processeur requis pour chaque instance. Unité : millicores. La valeur ne peut pas être 0. Actuellement, seules les spécifications définies suivantes sont prises en charge : 500 1000 2000 4000 8000 16000 32000	500
Mem	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 processeur. Actuellement, seules les spécifications définies suivantes sont prises en charge : 1024 : correspond à 500 et 1000 millicores 2048 : correspond à 500, 1000 et 2000 millicores 4096 : correspond à 1000, 2000 et 4000 millicores 8192 : correspond à 2000, 4000 et 8000 millicores 12288 : correspond à 12000 millicores 16384 : correspond à 4000, 8000 et 16000 millicores 24576 : correspond à 12000 millicores 32768 : correspond à 16000 millicores 65536 : correspond à 8000, 16000 et 32000 millicores 131072 : correspond à 32000 millicores	1024
Message	string	Les informations supplémentaires sur le résultat de l'opération.	success
ImageUrl	string	L'URL de l'image.	registry.cn-beijing.aliyuncs.com/sae-dev-test/nginx:stable
ErrorCode	string	Le code d'erreur. Prenez note des éléments suivants : Si la requête aboutit, le paramètre ErrorCode n'est pas renvoyé. Si la requête échoue, le paramètre ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.	InvalidAppId.NotFound
Code	string	Le code d'état HTTP ou le code d'erreur POP. Valeurs valides : 2xx : succès 3xx : redirection 4xx : erreur client 5xx : erreur serveur	200
Success	boolean	Indique si la liste des modèles de tâche a été consultée avec succès. Valeurs valides : true : La requête a réussi. false : La requête a échoué.	true
CurrentPage	integer	Le numéro de la page actuelle.	1
TotalSize	integer	Le nombre total de modèles de tâche.	2
PageSize	integer	Le nombre d'entrées par page.	20

Exemples

JSON format

{
  "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": "registry.cn-beijing.aliyuncs.com/sae-dev-test/nginx:stable"
      }
    ]
  },
  "ErrorCode": "InvalidAppId.NotFound",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

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.