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

Consulta se o Cloud Assistant Agent está instalado em uma ou mais instâncias. Se o Cloud Assistant estiver instalado, esta operação também consulta o número total de comandos do Cloud Assistant executados, o número de comandos em execução e a hora em que o último comando foi executado.

Descrição da operação

Chame esta operação para consultar o status do Cloud Assistant de uma instância antes de executar comandos ou enviar arquivos para a instância, especialmente para instâncias recém-adquiridas. Execute comandos ou envie arquivos apenas quando o parâmetro CloudAssistantStatus estiver definido como true.
Ao consultar a primeira página em uma consulta paginada, especifique apenas o parâmetro MaxResults para limitar o número de entradas a serem retornadas. O valor NextToken na resposta é usado como o token para consultar a próxima página. Ao consultar a próxima página em uma consulta paginada, defina o parâmetro NextToken com o valor NextToken obtido da resposta anterior e especifique o parâmetro 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

*Instance

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 a operação 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 será desativado em breve. Use NextToken e MaxResults para paginação em uma consulta paginada.	1
PageSize	integer	Não	Nota Este parâmetro será desativado em breve. Use NextToken e MaxResults para paginação em uma consulta paginada.	10
MaxResults	integer	Não	O número máximo de entradas por página para paginação em uma consulta paginada. Este parâmetro é inválido se as configurações do parâmetro InstanceId forem especificadas. Valor máximo: 50. Valor padrão: 10.	10
NextToken	string	Não	O token de paginação. Defina o valor como o valor NextToken retornado da chamada 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
PageSize	integer	O número de entradas por página.	1
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	O número da página atual.	1
TotalCount	integer	O número total de instâncias. Nota Se você usar os parâmetros MaxResults e NextToken para paginação em uma consulta paginada, o valor TotalCount retornado não é significativo.	1
NextToken	string	O token de paginação retornado pela chamada atual.	AAAAAdDWBF2
InstanceCloudAssistantStatusSet	object
InstanceCloudAssistantStatus	array<object>	O conjunto de resultados do status de instalação do Cloud Assistant das instâncias.
	object
CloudAssistantStatus	string	Indica se o Cloud Assistant está em execução na instância. Valores válidos: true: Um heartbeat é detectado dentro de 2 minutos. false: Nenhum heartbeat é detectado dentro de 2 minutos.	true
LastInvokedTime	string	A hora em que o último comando foi executado. A hora segue o padrão ISO 8601 e é exibida em UTC.	2021-03-15T08:00:00Z
CloudAssistantVersion	string	O número da versão do Cloud Assistant Agent. Se o Cloud Assistant Agent não estiver instalado ou em execução, este valor estará vazio.	2.2.0.106
ActiveTaskCount	integer	O número de tarefas do Cloud Assistant em execução na instância.	0
InvocationCount	integer	O número de tarefas do Cloud Assistant concluídas na instância.	2
InstanceId	string	O ID da instância.	i-bp1iudwa5b1tqa****
LastHeartbeatTime	string	A hora do último heartbeat do Cloud Assistant. Este valor é atualizado a cada minuto em média, com uma flutuação aleatória de até 5 segundos (o intervalo mais curto é de 55 segundos e o mais longo é de 65 segundos). A hora segue o padrão ISO 8601 e é exibida em UTC.	2021-03-15T09: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. Caso contrário, 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 recurso de gerenciamento de sessões são as seguintes: Linux: 2.2.3.189 Windows: 2.1.3.189	true

Exemplos

Resposta de sucesso

JSON formato

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

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 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 serviço está disponível na 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.