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

Chama DescribeCloudAssistantStatus para consultar se o Cloud Assistant Agent está instalado em uma ou mais instâncias. Se o Cloud Assistant estiver instalado, a operação também retorna o número total de execuções de comandos, o número de execuções em andamento e a hora da execução de comando mais recente.

Descrição da operação

Chame esta operação para consultar o status do Cloud Assistant de uma instância. Quando CloudAssistantStatus for true, execute comandos ou envie arquivos. Isso é especialmente importante para instâncias recém-criadas.
Ao consultar a primeira página de forma paginada, defina apenas MaxResults para limitar o número de entradas a serem retornadas. O valor NextToken na resposta é usado como credencial para consultar as páginas subsequentes. Ao consultar as páginas subsequentes de forma paginada, defina NextToken com o valor obtido da resposta anterior e defina MaxResults para limitar o número de entradas a serem retornadas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ecs:DescribeCloudAssistantStatus

get

*Instância.

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
OSType	string	Não	O tipo de sistema operacional da instância. Valores válidos: Windows Linux FreeBSD	Windows
PageNumber	integer	Não	Nota Este parâmetro está prestes a ser descontinuado. Use NextToken e MaxResults para realizar operações de paginação.	1
PageSize	integer	Não	Nota Este parâmetro está prestes a ser descontinuado. Use NextToken e MaxResults para realizar operações de paginação.	10
MaxResults	integer	Não	O número máximo de entradas por página para uma consulta paginada. Se InstanceId estiver definido, este parâmetro será ignorado. Valor máximo: 50. Valor padrão: 10.	10
NextToken	string	Não	O token de paginação. Defina este parâmetro com o valor NextToken retornado na chamada de API anterior.	AAAAAdDWBF2
InstanceId	array	Não	A lista de IDs de instâncias.	i-bp1iudwa5b1tqa****
	string	Não	A lista de IDs de instâncias, que pode incluir IDs de instâncias ECS e IDs de instâncias gerenciadas. Você pode especificar até 100 IDs de instâncias.	i-bp1iudwa5b1tqa****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
InstanceCloudAssistantStatusSet	object
InstanceCloudAssistantStatus	array<object>	A coleção de resultados do status de instalação do Cloud Assistant para as instâncias.
	object
ActiveTaskCount	integer	O número de tarefas do Cloud Assistant em execução na instância.	0
CloudAssistantStatus	string	Indica se o Cloud Assistant está em execução na instância. Valores válidos: true: Um heartbeat foi detectado nos últimos 2 minutos. false: Nenhum heartbeat foi detectado nos últimos 2 minutos.	true
CloudAssistantVersion	string	O número da versão do Cloud Assistant Agent. Este valor estará vazio se o Cloud Assistant Agent não estiver instalado ou não estiver em execução.	2.2.0.106
InstanceId	string	O ID da instância.	i-bp1iudwa5b1tqa****
InvocationCount	integer	O número de tarefas concluídas do Cloud Assistant na instância.	2
LastHeartbeatTime	string	A hora do heartbeat mais recente do Cloud Assistant. Este valor é atualizado aproximadamente a cada minuto com uma flutuação aleatória de até 5 segundos (mínimo de 55 segundos, máximo de 65 segundos). A hora segue o padrão ISO 8601 em UTC.	2021-03-15T09:00:00Z
LastInvokedTime	string	A hora da execução de comando mais recente. A hora segue o padrão ISO 8601 em UTC.	2021-03-15T08:00:00Z
OSType	string	O tipo de sistema operacional da instância. Valores válidos: Windows Linux FreeBSD	Linux
SupportSessionManager	boolean	Indica se o Cloud Assistant na instância oferece suporte ao recurso de gerenciamento de sessões. Se não houver suporte, a versão do Cloud Assistant está desatualizada. Atualize o cliente para a versão mais recente. As versões mínimas do Cloud Assistant que oferecem suporte ao gerenciamento de sessões são as seguintes: Linux: 2.2.3.189 Windows: 2.1.3.189	true
NextToken	string	O token de paginação retornado nesta chamada.	AAAAAdDWBF2
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número de entradas por página.	1
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	O número total de instâncias.	1

Exemplos

Resposta de sucesso

JSON formato

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

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.	A operação de API não é suportada na região especificada. Verifique se o valor do parâmetro RegionId está correto.
400	MissingParam.InstanceId	The parameter instanceId is missing or empty.	O ID da instância está vazio.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	O parâmetro MaxResults especificado é inválido.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Ocorreu um erro ao enviar a solicitação. Tente novamente mais tarde.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	InstanceIds.ExceedLimit	The number of instance IDs exceeds the upper limit.	O número de instâncias de destino excede o limite superior.
403	Operation.Forbidden	The operation is not permitted.	A operação não é permitida.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	O RegionId especificado não existe. Verifique se o produto está disponível nesta região.
404	InvalidInstance.NotFound	The specified instance does not exist.	A instância especificada não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.