DescribeCloudAssistantStatus - : Central de Documentação do Alibaba Cloud

Observações de uso

Antes de executar comandos ou enviar arquivos para instâncias, especialmente as novas, recomendamos consultar o status do Cloud Assistant chamando esta operação e verificando o valor retornado em CloudAssistantStatus. Execute comandos ou envie arquivos para as instâncias apenas quando o valor retornado for true.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeCloudAssistantStatus	A operação a ser executada. Defina o valor como DescribeCloudAssistantStatus.
RegionId	String	Sim	cn-hangzhou	O ID da região da instância. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
OSType	String	Não	Windows	O tipo de sistema operacional da instância. Valores válidos: Windows Linux FreeBSD
PageNumber	Long	Não	1	O número da página. A numeração das páginas começa em 1. Valor padrão: 1.
PageSize	Long	Não	10	A quantidade de entradas por página. Se você especificar InstanceId, este parâmetro não terá efeito. Valores válidos: 1 a 50. Valor padrão: 10.
InstanceId.N	String	Não	i-bp1iudwa5b1tqa****	O ID da instância N. A instância pode ser do Elastic Compute Service (ECS) ou gerenciada. É possível especificar até 100 IDs de instância em uma única solicitação.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageSize	Long	1	A quantidade de entradas por página.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	O ID da solicitação.
PageNumber	Long	1	O número da página.
TotalCount	Long	1	O número total de instâncias.
InstanceCloudAssistantStatusSet	Array of InstanceCloudAssistantStatus		Detalhes sobre o status de instalação do Cloud Assistant Agent nas instâncias.
InstanceCloudAssistantStatus
CloudAssistantStatus	String	true	Indica se o Cloud Assistant está em execução na instância. Valores válidos: true: heartbeats detectados nos últimos 2 minutos. false: nenhum heartbeat detectado nos últimos 2 minutos.
LastInvokedTime	String	2021-03-15T08:00:00Z	O horário da última execução de comandos.
CloudAssistantVersion	String	2.2.0.106	O número da versão do Cloud Assistant Agent. Este parâmetro fica vazio se o Cloud Assistant Agent não estiver instalado ou em execução na instância.
ActiveTaskCount	Long	0	A quantidade de tarefas que o Cloud Assistant estava executando na instância.
InvocationCount	Long	2	O número de tarefas concluídas pelo Cloud Assistant na instância.
InstanceId	String	i-bp1iudwa5b1tqa****	O ID da instância.
LastHeartbeatTime	String	2021-03-15T09:00:00Z	O horário do último heartbeat do Cloud Assistant. O valor é atualizado, em média, a cada minuto. O intervalo pode ser de 55, 60 ou 65 segundos.
OSType	String	Linux	O tipo de sistema operacional da instância. Valores válidos: Windows Linux FreeBSD
SupportSessionManager	Boolean	true	Indica se o Cloud Assistant oferece suporte ao Session Manager na instância. Se o Session Manager não for suportado, a versão do Cloud Assistant está desatualizada. Atualize o Cloud Assistant Agent para a versão mais recente. Para oferecer suporte ao Session Manager, a versão do Cloud Assistant deve ser igual ou superior às seguintes: Linux: 2.2.3.189 Windows: 2.1.3.189

Exemplos

Exemplos de solicitações

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

Exemplo de resposta de sucesso

Formato 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>

Formato JSON

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"
    } ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	RegionId.ApiNotSupported	The api is not supported in this region.	Esta operação não pode ser realizada na região especificada. Verifique se o ID da região é válido.
400	MissingParam.InstanceId	The parameter instanceId is missing or empty.	É necessário especificar os IDs das instâncias.
400	InvalidParam.PageSize	The specified parameter is invalid.	Valor de PageSize inválido.
400	InvalidParam.PageNumber	The specified parameter is invalid.	Valor de PageNumber inválido.
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	O número máximo de IDs de instância foi excedido.
403	Operation.Forbidden	The operation is not permitted.	A operação não é suportada.
404	InvalidInstance.NotFound	The specified instance does not exist.	A instância especificada não foi encontrada.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Ocorreu um erro durante o envio da solicitação. Tente novamente mais tarde.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	A solicitação falhou devido a uma falha temporária no servidor backend.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.