DescribeCloudAssistantStatus - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Avant d'exécuter des commandes ou d'envoyer des fichiers vers des instances, en particulier des instances nouvellement créées, nous vous recommandons de vérifier l'état de Cloud Assistant sur ces instances en appelant cette opération et en examinant la valeur de retour CloudAssistantStatus. Exécutez des commandes ou envoyez des fichiers aux instances uniquement si la valeur de retour est true.

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	DescribeCloudAssistantStatus	L'opération à effectuer. Définissez la valeur sur DescribeCloudAssistantStatus.
RegionId	String	Yes	cn-hangzhou	L'ID de région de l'instance. Appelez DescribeRegions pour obtenir la liste des régions la plus récente.
OSType	String	No	Windows	Le type de système d'exploitation de l'instance. Valeurs possibles : Windows Linux FreeBSD
PageNumber	Long	No	1	Le numéro de page. La pagination commence à la page 1. Valeur par défaut : 1.
PageSize	Long	No	10	Le nombre d'entrées par page. Si vous spécifiez InstanceId, ce paramètre est ignoré. Valeurs possibles : 1 à 50. Valeur par défaut : 10.
InstanceId.N	String	No	i-bp1iudwa5b1tqa****	L'ID de l'instance N. L'instance peut être une instance Elastic Compute Service (ECS) ou une instance gérée. Vous pouvez spécifier jusqu'à 100 ID d'instance dans une seule requête.

Paramètres de réponse

Parameter	Type	Example	Description
PageSize	Long	1	Le nombre d'entrées par page.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	L'ID de la requête.
PageNumber	Long	1	Le numéro de page.
TotalCount	Long	1	Le nombre total d'instances.
InstanceCloudAssistantStatusSet	Array of InstanceCloudAssistantStatus		Détails sur l'état d'installation de Cloud Assistant Agent sur les instances.
InstanceCloudAssistantStatus
CloudAssistantStatus	String	true	Indique si Cloud Assistant est en cours d'exécution sur l'instance. Valeurs possibles : true : Des signaux heartbeat sont détectés dans un délai de 2 minutes. false : Aucun signal heartbeat n'est détecté dans un délai de 2 minutes.
LastInvokedTime	String	2021-03-15T08:00:00Z	L'heure de la dernière exécution des commandes.
CloudAssistantVersion	String	2.2.0.106	Le numéro de version de Cloud Assistant Agent. Ce paramètre est vide si Cloud Assistant Agent n'est pas installé ou n'est pas en cours d'exécution sur l'instance.
ActiveTaskCount	Long	0	Le nombre de tâches en cours d'exécution par Cloud Assistant sur l'instance.
InvocationCount	Long	2	Le nombre de tâches terminées par Cloud Assistant sur l'instance.
InstanceId	String	i-bp1iudwa5b1tqa****	L'ID de l'instance.
LastHeartbeatTime	String	2021-03-15T09:00:00Z	L'heure du dernier signal heartbeat de Cloud Assistant. La valeur est mise à jour toutes les minutes en moyenne. L'intervalle peut être de 55, 60 ou 65 secondes.
OSType	String	Linux	Le type de système d'exploitation de l'instance. Valeurs possibles : Windows Linux FreeBSD
SupportSessionManager	Boolean	true	Indique si Cloud Assistant prend en charge Session Manager sur l'instance. Si Session Manager n'est pas pris en charge, la version de Cloud Assistant est obsolète. Mettez à jour Cloud Assistant Agent vers la dernière version. Pour prendre en charge Session Manager, la version de Cloud Assistant doit être au moins égale aux versions suivantes : Linux : 2.2.3.189 Windows : 2.1.3.189

Exemples

Exemple de requête

https://ecs.aliyuncs.com/?Action=DescribeCloudAssistantStatus
&InstanceId.1=i-bp1iudwa5b1tqa****
&RegionId=cn-hangzhou
&<Common request parameters>

Exemple de réponse réussie

Format XML

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

<DescribeCloudAssistantStatusResponse>
    <TotalCount>1</TotalCount>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageSize>1</PageSize>
    <PageNumber>1</PageNumber>
    <InstanceCloudAssistantStatusSet>
        <InstanceCloudAssistantStatus>
            <CloudAssistantVersion>2.2.0.106</CloudAssistantVersion>
            <SupportSessionManager>true</SupportSessionManager>
            <InstanceId>i-bp1iudwa5b1tqa****</InstanceId>
            <CloudAssistantStatus>true</CloudAssistantStatus>
            <OSType>Linux</OSType>
            <InvocationCount>2</InvocationCount>
            <ActiveTaskCount>0</ActiveTaskCount>
            <LastInvokedTime>2021-03-15T08:00:00Z</LastInvokedTime>
            <LastHeartbeatTime>2021-03-15T09:00:00Z</LastHeartbeatTime>
        </InstanceCloudAssistantStatus>
    </InstanceCloudAssistantStatusSet>
</DescribeCloudAssistantStatusResponse>

JSON format

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

{
  "TotalCount" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize" : 1,
  "PageNumber" : 1,
  "InstanceCloudAssistantStatusSet" : {
    "InstanceCloudAssistantStatus" : [ {
      "CloudAssistantVersion" : "2.2.0.106",
      "SupportSessionManager" : true,
      "InstanceId" : "i-bp1iudwa5b1tqa****",
      "CloudAssistantStatus" : "true",
      "OSType" : "Linux",
      "InvocationCount" : 2,
      "ActiveTaskCount" : 0,
      "LastInvokedTime" : "2021-03-15T08:00:00Z",
      "LastHeartbeatTime" : "2021-03-15T09:00:00Z"
    } ]
  }
}

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 n'est pas prise en charge dans la région spécifiée. Vérifiez la validité de l'ID de région.
400	MissingParam.InstanceId	The parameter instanceId is missing or empty.	Les ID d'instance doivent être spécifiés.
400	InvalidParam.PageSize	The specified parameter is invalid.	Valeur PageSize non valide.
400	InvalidParam.PageNumber	The specified parameter is invalid.	Valeur PageNumber non valide.
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	Le nombre maximal d'ID d'instance est dépassé.
403	Operation.Forbidden	The operation is not permitted.	L'opération n'est pas autorisée.
404	InvalidInstance.NotFound	The specified instance does not exist.	L'instance spécifiée est introuvable.
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.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	La requête a échoué en raison d'une défaillance temporaire du serveur backend.

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