DescribeInvocations - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Une commande peut échouer ou ne pas renvoyer les résultats attendus après son exécution. Appelez cette opération pour interroger les résultats d'exécution.
Vous pouvez interroger les informations relatives aux tâches de commande des quatre dernières semaines. Jusqu'à 100 000 entrées d'informations sur les tâches peuvent être conservées.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeInvocations	L'opération à effectuer. Définissez la valeur sur DescribeInvocations.
RegionId	String	Yes	cn-hangzhou	L'ID de région de la commande. Appelez l'opération DescribeRegions pour interroger la liste des régions la plus récente.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	L'ID du groupe de ressources. Si vous définissez ce paramètre, le système interroge les résultats d'exécution des commandes dans le groupe de ressources spécifié.
InvokeId	String	No	t-hz0jdfwd9f****	L'ID de la tâche de commande.
CommandId	String	No	c-hz0jdfwcsr****	L'ID de la commande. Appelez l'opération DescribeCommands pour interroger tous les ID de commande disponibles.
CommandName	String	No	CommandTestName	Le nom de la commande. Si ce paramètre et `InstanceId` sont tous deux spécifiés, ce paramètre est ignoré.
CommandType	String	No	RunShellScript	Le type de la commande. Valeurs valides : RunBatScript : commande batch, applicable aux instances Windows RunPowerShellScript : commande PowerShell, applicable aux instances Windows RunShellScript : commande shell, applicable aux instances Linux
Timed	Boolean	No	true	Indique si la commande doit être exécutée automatiquement. Valeurs valides : true : La commande est exécutée en appelant l'opération `RunCommand` ou `InvokeCommand` avec `RepeatMode` défini sur `Period`, `NextRebootOnly` ou `EveryReboot`. false : La commande répond aux exigences suivantes : La commande est exécutée en appelant l'opération `RunCommand` ou `InvokeCommand` avec `RepeatMode` défini sur `Once`. La commande comporte des tâches annulées, arrêtées ou terminées. Valeur par défaut : false.
InvokeStatus	String	No	Finished	L'état d'exécution global de la tâche de commande. La valeur de ce paramètre dépend des états d'exécution sur toutes les instances concernées. Valeurs valides : Running : Tâche planifiée : L'état d'exécution global reste toujours Running tant que vous n'avez pas arrêté manuellement l'exécution planifiée de la commande. Tâche ponctuelle : Si la commande est en cours d'exécution sur les instances, l'état d'exécution global est Running. Finished : Tâche planifiée : L'état d'exécution global ne peut jamais être Finished. Tâche ponctuelle : L'exécution est terminée sur toutes les instances, ou elle est arrêtée manuellement sur certaines instances et terminée sur les autres. Success : Si l'état d'exécution sur au moins une instance est Success et que l'état d'exécution sur les autres instances est Stopped ou Success, l'état d'exécution global est Success. Tâche configurée pour s'exécuter immédiatement : L'exécution est terminée et le code de sortie est 0. Tâche planifiée : La dernière exécution est achevée, le code de sortie est 0 et la période spécifiée est terminée. Failed : Tâche planifiée : L'état d'exécution global ne peut jamais être Failed. Tâche ponctuelle : L'exécution échoue sur toutes les instances. Stopped : La tâche est arrêtée. Stopping : La tâche est en cours d'arrêt. PartialFailed : La tâche échoue sur certaines instances. Si `InstanceId` est spécifié, InvokeStatus est ignoré.
InstanceId	String	No	i-bp1i7gg30r52z2em****	L'ID de l'instance. Si vous spécifiez ce paramètre, le système interroge tous les enregistrements d'exécution de toutes les commandes exécutées sur l'instance.
ContentEncoding	String	No	PlainText	Le mode d'encodage des valeurs `CommandContent` et `Output` dans la réponse. Valeurs valides : PlainText : renvoie le contenu original de la commande et les sorties de commande. Base64 : renvoie le contenu de la commande et les sorties de commande encodés en Base64. Valeur par défaut : Base64.
IncludeOutput	Boolean	No	false	Indique s'il faut renvoyer les sorties de commande dans la réponse. true : renvoie les sorties de commande. Si ce paramètre est défini sur true, vous devez spécifier `InvokeId`, `InstanceId` ou les deux. false : ne renvoie pas les sorties de commande. Valeur par défaut : false.
PageNumber	Long	No	1	Le numéro de page. La numérotation des pages commence à 1. Valeur par défaut : 1.
PageSize	Long	No	10	Le nombre d'entrées par page. Valeurs valides : 1 à 50. Valeur par défaut : 10.
RepeatMode	String	No	Once	Le mode d'exécution de la commande. Si ce paramètre et `InstanceId` sont tous deux spécifiés, ce paramètre est ignoré. Valeurs valides : Once : La commande est exécutée immédiatement. Period : La commande est exécutée selon un planning. NextRebootOnly : La commande est exécutée au prochain démarrage de l'instance. EveryReboot : La commande est exécutée à chaque démarrage de l'instance. Ce paramètre est vide par défaut, ce qui indique que les commandes exécutées dans tous les modes sont interrogées.
Tag.N.Key	String	No	TestKey	La clé du tag N de la tâche de commande. Valeurs valides de N : 1 à 20. La clé de tag ne peut pas être une chaîne vide. Si vous spécifiez un seul tag pour interroger des ressources, jusqu'à 1 000 ressources auxquelles le tag est ajouté sont renvoyées. Si vous spécifiez plusieurs tags pour interroger des ressources, jusqu'à 1 000 ressources auxquelles tous les tags spécifiés sont ajoutés sont renvoyées. Pour interroger plus de 1 000 ressources auxquelles les tags spécifiés sont ajoutés, appelez l'opération ListTagResources. La clé de tag peut comporter jusqu'à 64 caractères et ne peut pas contenir `http://` ou `https://`. Elle ne peut pas commencer par `acs:` ou `aliyun`.
Tag.N.Value	String	No	TestValue	La valeur du tag N de la tâche de commande. Valeurs valides de N : 1 à 20. La valeur de tag peut être une chaîne vide. La valeur de tag peut comporter jusqu'à 128 caractères et ne peut pas contenir `http://` ou `https://`.

Paramètres de réponse

Parameter	Type	Example	Description
PageSize	Long	10	Le nombre d'entrées par page.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	L'ID de la requête.
PageNumber	Long	1	Le numéro de page.
TotalCount	Long	1	Le nombre total de commandes.
Invocations	Array of Invocation		Les tâches de commande interrogées.
Invocation
CreationTime	String	2020-01-19T09:15:46Z	L'heure de création de la tâche de commande.
Frequency	String	0 /20 * * *	Le planning d'exécution de la commande.
InvocationStatus	String	Running	L'état d'exécution global de la tâche de commande. La valeur de ce paramètre dépend des états d'exécution sur toutes les instances concernées. Valeurs valides : Pending : La commande était en cours de vérification ou d'envoi. Si l'état d'exécution est Pending sur au moins une instance, l'état d'exécution global est Pending. Scheduled : La commande configurée pour s'exécuter selon un planning a été envoyée et attend d'être exécutée. Si l'état d'exécution est Scheduled sur au moins une instance, l'état d'exécution global est Scheduled. Running : La commande était en cours d'exécution sur les instances. Si l'état d'exécution est Running sur au moins une instance, l'état d'exécution global est Running. Success : Si l'état d'exécution sur au moins une instance est Success et que l'état d'exécution sur les autres instances est Stopped ou Success, l'état d'exécution global est Success. Tâche configurée pour s'exécuter immédiatement : La tâche de commande est achevée et le code de sortie est 0. Tâche planifiée : La dernière exécution est achevée, le code de sortie est 0 et la période spécifiée est terminée. Failed : Si l'état d'exécution sur toutes les instances est Stopped ou Failed, l'état d'exécution global est Failed. Si l'état d'exécution sur une instance correspond à l'une des valeurs suivantes, Failed est renvoyé comme état d'exécution global : Invalid : La commande n'est pas valide. Aborted : L'envoi de la commande a échoué. Failed : La tâche de commande est achevée, mais le code de sortie n'est pas 0. Timeout : L'exécution a expiré. Error : Une erreur s'est produite lors de l'exécution de la commande. Stopping : La tâche de commande était en cours d'arrêt. Si l'état d'exécution d'au moins une instance est Stopping, l'état d'exécution global est Stopping. Stopped : La tâche de commande a été arrêtée. Si l'état d'exécution sur toutes les instances est Stopped, l'état d'exécution global est Stopped. Si l'état d'exécution sur une instance correspond à l'une des valeurs suivantes, Stopped est renvoyé comme état d'exécution global : Cancelled : La tâche de commande a été annulée. Terminated : La tâche de commande a été interrompue. PartialFailed : La tâche de commande a réussi sur certaines instances et a échoué sur d'autres. Lorsque l'état d'exécution est Success sur certaines instances et Failed ou Stopped sur les autres, l'état d'exécution global est PartialFailed. Remarque `InvokeStatus` dans la réponse fonctionne de manière similaire à ce paramètre. Nous vous recommandons de vérifier la valeur de ce paramètre.
RepeatMode	String	Once	Le mode d'exécution de la commande. Valeurs valides : Once : La commande est exécutée immédiatement. Period : La commande est exécutée selon un planning. NextRebootOnly : La commande est exécutée au prochain démarrage de l'instance. EveryReboot : La commande est exécutée à chaque démarrage de l'instance.
CommandId	String	c-hz0jdfwcsr****	L'ID de la commande.
CommandType	String	RunShellScript	Le type de la commande.
InvokeStatus	String	Finished	L'état d'exécution global de la tâche de commande. Remarque Nous vous recommandons d'ignorer ce paramètre et de vérifier la valeur de `InvocationStatus` dans la réponse pour connaître l'état d'exécution global.
Parameters	String	{}	Les paramètres personnalisés dans la commande.
Timed	Boolean	false	Indique si la commande doit être exécutée automatiquement.
CommandContent	String	cnBtIC1xYSB8IGdyZXAgdnNm****	Le contenu de la commande. Si ContentEncoding est défini sur PlainText dans la requête, le contenu original de la commande est renvoyé. Si ContentEncoding est défini sur Base64 dans la requête, le contenu de la commande encodé en Base64 est renvoyé.
CommandName	String	CommandTestName	Le nom de la commande.
CommandDescription	String	testDescription	La description de la commande.
InvokeId	String	t-hz0jdfwd9f****	L'ID de la tâche de commande.
Username	String	test	Le nom d'utilisateur utilisé pour exécuter la commande sur l'instance.
WorkingDir	String	/home/	Le chemin d'exécution de la commande.
Timeout	Long	60	Le délai d'expiration maximal pour les exécutions de commandes sur l'instance. Unité : secondes. Lorsqu'une commande ne peut pas être exécutée, une erreur de délai d'expiration se produit. Lorsqu'une exécution de commande expire, Cloud Assistant Agent termine de force le processus de commande en annulant l'identifiant de processus (PID).
ContainerId	String	ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****	L'ID du conteneur.
ContainerName	String	test-container	Le nom du conteneur.
InvokeInstances	Array of InvokeInstance		Les instances sur lesquelles la commande a été exécutée.
InvokeInstance
CreationTime	String	2019-12-20T06:15:54Z	L'heure à laquelle la commande a commencé à s'exécuter sur l'instance.
UpdateTime	String	2020-01-19T09:15:47Z	L'heure de mise à jour de l'état d'exécution.
FinishTime	String	2019-12-20T06:15:56Z	L'heure de fin du processus de commande.
InvocationStatus	String	Success	L'état d'exécution sur une seule instance. Valeurs valides : Pending : La commande était en cours de vérification ou d'envoi. Invalid : Le type de commande ou le paramètre spécifié n'était pas valide. Aborted : L'envoi de la commande a échoué. Pour envoyer une commande à une instance, assurez-vous que l'instance est dans l'état Running et que la commande peut être envoyée dans un délai d'une minute. Running : La commande était en cours d'exécution sur l'instance. Success : Commande configurée pour s'exécuter une seule fois : L'exécution est achevée et le code de sortie est 0. Commande configurée pour s'exécuter selon un planning : L'exécution précédente est achevée, le code de sortie est 0 et la période spécifiée est terminée. Failed : Commande configurée pour s'exécuter une seule fois : L'exécution est achevée, mais le code de sortie n'est pas 0. Commande configurée pour s'exécuter selon un planning : L'exécution précédente est achevée, mais le code de sortie n'est pas 0. La période spécifiée était sur le point de se terminer. Error : L'exécution ne peut pas se poursuivre en raison d'une exception. Timeout : L'exécution a expiré. Cancelled : L'exécution a été annulée et la commande n'a pas été exécutée. Stopping : La tâche de commande était en cours d'arrêt. Terminated : L'exécution a été interrompue pendant l'exécution de la commande. Scheduled : Commande configurée pour s'exécuter une seule fois : L'état d'exécution global ne peut jamais être Scheduled. Commande configurée pour s'exécuter selon un planning : La commande attendait d'être exécutée.
Repeats	Integer	0	Le nombre de fois où la commande a été exécutée sur l'instance. Si la commande est configurée pour s'exécuter une seule fois, la valeur est 0 ou 1. Si la commande est configurée pour s'exécuter selon un planning, la valeur correspond au nombre de fois où la commande a été exécutée.
InstanceId	String	i-bp1i7gg30r52z2em****	L'ID de l'instance.
Output	String	OutPutTestmsg	La sortie de la commande. Si ContentEncoding est défini sur PlainText dans la requête, la sortie originale de la commande est renvoyée. Si ContentEncoding est défini sur Base64 dans la requête, la sortie de la commande encodée en Base64 est renvoyée.
Dropped	Integer	0	La taille du texte Output tronqué et ignoré lorsque la valeur Output dépasse 24 Ko.
StopTime	String	2020-01-19T09:15:47Z	L'heure à laquelle la tâche de commande a été arrêtée. Si vous appelez l'opération `StopInvocation` pour arrêter la tâche de commande, la valeur de ce paramètre correspond à l'heure d'appel de l'opération.
ExitCode	Long	0	Le code de sortie de l'exécution. Valeurs valides : Pour les instances Linux, le code de sortie est le code de sortie du processus shell. Pour les instances Windows, le code de sortie est le code de sortie du processus batch ou PowerShell.
StartTime	String	2019-12-20T06:15:55Z	L'heure à laquelle la commande a commencé à s'exécuter sur l'instance.
ErrorInfo	String	the specified instance does not exists	La raison pour laquelle l'envoi ou l'exécution de la commande a échoué. Valeurs valides : Si ce paramètre est vide, la commande a été exécutée normalement. the specified instance does not exist the instance has released when create task the instance is not running when create task the command is not applicable the specified account does not exist the specified directory does not exist the cron job expression is invalid the aliyun service is not running on the instance the aliyun service in the instance does not response the aliyun service in the instance is upgrading now the aliyun service in the instance need upgrade the command delivery has been timeout the command execution has been timeout the command execution got an exception the command execution has been interrupted the command execution exit code is not zero the specified instance has been released
Timed	Boolean	false	Indique si la commande doit être exécutée automatiquement.
ErrorCode	String	InstanceNotExists	Le code indiquant la raison de l'échec de l'envoi ou de l'exécution de la commande. Valeurs valides : Si ce paramètre est vide, la commande a été exécutée normalement. InstanceNotExists : L'instance n'existait pas ou a été libérée. InstanceReleased : L'instance a été libérée pendant l'exécution de la commande. InstanceNotRunning : L'instance n'était pas en cours d'exécution au début de l'exécution de la commande. CommandNotApplicable : La commande n'était pas applicable à l'instance spécifiée. AccountNotExists : Le compte spécifié n'existait pas. DirectoryNotExists : Le répertoire spécifié n'existait pas. BadCronExpression : L'expression cron utilisée pour spécifier un planning n'était pas valide. ClientNotRunning : Cloud Assistant Agent n'était pas en cours d'exécution. ClientNotResponse : Cloud Assistant Agent n'a pas répondu. ClientIsUpgrading : Cloud Assistant Agent était en cours de mise à niveau. ClientNeedUpgrade : Cloud Assistant Agent doit être mis à niveau. DeliveryTimeout : La demande d'envoi de la commande a expiré. ExecutionTimeout : L'exécution a expiré. ExecutionException : Une exception s'est produite lors de l'exécution de la commande. ExecutionInterrupted : La tâche de commande a été interrompue. ExitCodeNonzero : La tâche de commande est achevée, mais le code de sortie n'est pas 0.
InstanceInvokeStatus	String	Finished	L'état d'exécution sur une seule instance. Remarque Nous vous recommandons d'ignorer ce paramètre et de vérifier la valeur de `InvocationStatus` dans la réponse pour connaître l'état d'exécution global.
Tags	Array of Tag		Les tags de la tâche de commande.
Tag
TagKey	String	owner	La clé de tag de la tâche de commande.
TagValue	String	zhangsan	La valeur de tag de la tâche de commande.

Exemples

Exemples de requêtes

http(s)://ecs.aliyuncs.com/?Action=DescribeInvocations
&RegionId=cn-hangzhou
&InvokeId=t-hz0jdfwd9f****
&CommandId=c-hz0jdfwcsr****
&CommandName=CommandTestName
&CommandType=RunShellScript
&Timed=true
&InvokeStatus=Finished
&InstanceId=i-bp1i7gg30r52z2em****
&PageNumber=1
&PageSize=10
&RepeatMode=Once
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInvocationsResponse>
    <PageSize>10</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Invocations>
        <Invocation>
            <CreationTime>2020-01-19T09:15:46Z</CreationTime>
            <Frequency>0 */20 * * * *</Frequency>
            <InvocationStatus>Running</InvocationStatus>
            <RepeatMode>Once</RepeatMode>
            <CommandId>c-hz0jdfwcsr****</CommandId>
            <CommandType>RunShellScript</CommandType>
            <InvokeStatus>Finished</InvokeStatus>
            <Parameters>{}</Parameters>
            <Timed>false</Timed>
            <CommandContent>cnBtIC1xYSB8IGdyZXAgdnNm****</CommandContent>
            <CommandName>CommandTestName</CommandName>
            <CommandDescription>testDescription</CommandDescription>
            <InvokeId>t-hz0jdfwd9f****</InvokeId>
            <Username>test</Username>
            <WorkingDir>/home/</WorkingDir>
            <Timeout>60</Timeout>
            <ContainerId>ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****</ContainerId>
            <ContainerName>test-container</ContainerName>
            <InvokeInstances>
                <InvokeInstance>
                    <CreationTime>2019-12-20T06:15:54Z</CreationTime>
                    <UpdateTime>2020-01-19T09:15:47Z</UpdateTime>
                    <FinishTime>2019-12-20T06:15:56Z</FinishTime>
                    <InvocationStatus>Success</InvocationStatus>
                    <Repeats>0</Repeats>
                    <InstanceId>i-bp1i7gg30r52z2em****</InstanceId>
                    <Output>OutPutTestmsg</Output>
                    <Dropped>0</Dropped>
                    <StopTime>2020-01-19T09:15:47Z</StopTime>
                    <ExitCode>0</ExitCode>
                    <StartTime>2019-12-20T06:15:55Z</StartTime>
                    <ErrorInfo>the specified instance does not exists</ErrorInfo>
                    <Timed>false</Timed>
                    <ErrorCode>InstanceNotExists</ErrorCode>
                    <InstanceInvokeStatus>Finished</InstanceInvokeStatus>
                </InvokeInstance>
                <Tags>
                    <TagKey>owner</TagKey>
                    <TagValue>zhangsan</TagValue>
                </Tags>
            </InvokeInstances>
        </Invocation>
    </Invocations>
</DescribeInvocationsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "Invocations" : {
    "Invocation" : [ {
      "CreationTime" : "2020-01-19T09:15:46Z",
      "Frequency" : "0 */20 * * * *",
      "InvocationStatus" : "Running",
      "RepeatMode" : "Once",
      "CommandId" : "c-hz0jdfwcsr****",
      "CommandType" : "RunShellScript",
      "InvokeStatus" : "Finished",
      "Parameters" : "{}",
      "Timed" : false,
      "CommandContent" : "cnBtIC1xYSB8IGdyZXAgdnNm****",
      "CommandName" : "CommandTestName",
      "CommandDescription" : "testDescription",
      "InvokeId" : "t-hz0jdfwd9f****",
      "Username" : "test",
      "WorkingDir" : "/home/",
      "Timeout" : 60,
      "ContainerId" : "ab141ddfbacfe02d9dbc25966ed971536124527097398d419a6746873fea****",
      "ContainerName" : "test-container",
      "InvokeInstances" : {
        "InvokeInstance" : [ {
          "CreationTime" : "2019-12-20T06:15:54Z",
          "UpdateTime" : "2020-01-19T09:15:47Z",
          "FinishTime" : "2019-12-20T06:15:56Z",
          "InvocationStatus" : "Success",
          "Repeats" : 0,
          "InstanceId" : "i-bp1i7gg30r52z2em****",
          "Output" : "OutPutTestmsg",
          "Dropped" : 0,
          "StopTime" : "2020-01-19T09:15:47Z",
          "ExitCode" : 0,
          "StartTime" : "2019-12-20T06:15:55Z",
          "ErrorInfo" : "the specified instance does not exists",
          "Timed" : false,
          "ErrorCode" : "InstanceNotExists",
          "InstanceInvokeStatus" : "Finished"
        } ],
        "Tags" : [ {
          "TagKey" : "owner",
          "TagValue" : "zhangsan"
        } ]
      }
    } ]
  }
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	RegionId.ApiNotSupported	The api is not supported in this region.	Cette opération ne peut pas être effectuée dans la région spécifiée. Vérifiez si la valeur du paramètre RegionId est valide.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	La clé de tag existe déjà. Les clés de tag doivent être uniques.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	Valeur Tag.N.Key non valide.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	Valeur Tag.N.Value non valide.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	Tag.N.Key est requis.
400	InvalidParam.PageNumber	The specified parameter is invalid.	Valeur PageNumber non valide.
400	InvalidParam.PageSize	The specified parameter is invalid.	Valeur PageSize non valide.
403	Operation.Forbidden	The operation is not permitted.	L'opération n'est pas prise en charge.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Une erreur s'est produite lors de l'envoi de la requête. Réessayez ultérieurement.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.