DescribeMonitoringAgentHosts - Cloud Monitor: Central de Documentação do Alibaba Cloud

Consulta uma lista de todos os hosts, independentemente de o agente do CloudMonitor estar instalado.

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

cms:DescribeMonitoringAgentHosts

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
KeyWord	string	Não	A palavra-chave para uma pesquisa aproximada.	host1
HostName	string	Não	O nome do host.	hostNam1
InstanceIds	string	Não	O ID da instância.	i-a3d1q1pm2f9yr29e****
SerialNumbers	string	Não	O número de série do host. Um número de série globalmente exclusivo é gerado após a instalação bem-sucedida do agente do CloudMonitor em um host. Hosts que não são instâncias da Alibaba Cloud não possuem um ID de instância, mas possuem um número de série. Nota Use este parâmetro para encontrar um host monitorado específico.	a1ab31a3-1234-40f2-9e95-c8caa8f0****
PageNumber	integer	Não	O número da página.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 10 20 50 100 Nota A Alibaba Cloud não limita o valor máximo deste parâmetro. No entanto, definir este parâmetro com um valor muito alto pode causar um timeout.	10
InstanceRegionId	string	Não	A região onde a instância reside.	cn-hangzhou
AliyunHost	boolean	Não	Especifica se deve filtrar por instâncias do Alibaba Cloud Elastic Compute Service (ECS). Valores válidos: true (padrão): Retorna apenas instâncias ECS. false: Retorna apenas hosts que não são instâncias ECS.	true
Status	string	Não	O status do host. Valores válidos: Running: O host está em execução. Stopped: O host está parado, o agente não está instalado ou a instalação do agente falhou.	Running
SysomStatus	string	Não	O status do SysOM. Valores válidos: installing: O SysOM está sendo ativado. running: O SysOM está em execução. stopped: O SysOM está parado. uninstalling: O SysOM está sendo desativado.	running

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: A operação foi bem-sucedida. false: A operação falhou.	true
Code	string	O código de status. Nota Um código de status 200 indica uma resposta bem-sucedida.	200
Message	string	A mensagem de erro.	The Request is not authorization.
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
PageTotal	integer	O número de páginas.	50
Total	integer	O número total de entradas.	10
Hosts	object
Host	array<object>	A lista de hosts.
	object	O host.
SerialNumber	string	The serial number of the host. Hosts that are not Alibaba Cloud instances do not have an instance ID, but have a serial number. Nota Use this parameter to find a specific monitored host.	x12335-6cc8-4a22-9f21-1a00a719****
NatIp	string	The NAT IP address.	192.168.XX.XX
HostName	string	The hostname.	hostIP
AliUid	integer	The ID of the Alibaba Cloud account.	103201326074****
NetworkType	string	The network type.	vpc
InstanceId	string	The instance ID.	i-a2d5q7pm3f9yr212****
isAliyunHost	boolean	Indicates whether the host is an Alibaba Cloud instance. Valid values: true: The host is an Alibaba Cloud instance. false: The host is not an Alibaba Cloud instance.	true
EipAddress	string	The elastic IP address (EIP).	192.168.XX.XX
AgentVersion	string	The agent version.	3.4.6
IpGroup	string	The IP address of the host. Nota Multiple IP addresses are separated by commas (,).	192.168.XX.XX
EipId	string	The ID of the EIP.	eip-bp16i16k9gcezyfrp****
Region	string	The region.	cn-hangzhou
InstanceTypeFamily	string	The ECS instance type family.	ecs.n4
OperatingSystem	string	The operating system.	Linux

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "63EEBB2A-9E51-41E4-9E83-5DE7F3B292E0",
  "Success": true,
  "Code": "200",
  "Message": "The Request is not authorization.",
  "PageNumber": 1,
  "PageSize": 10,
  "PageTotal": 50,
  "Total": 10,
  "Hosts": {
    "Host": [
      {
        "SerialNumber": "x12335-6cc8-4a22-9f21-1a00a719****",
        "NatIp": "192.168.XX.XX",
        "HostName": "hostIP",
        "AliUid": 0,
        "NetworkType": "vpc",
        "InstanceId": "i-a2d5q7pm3f9yr212****",
        "isAliyunHost": true,
        "EipAddress": "192.168.XX.XX",
        "AgentVersion": "3.4.6",
        "IpGroup": "192.168.XX.XX",
        "EipId": "eip-bp16i16k9gcezyfrp****",
        "Region": "cn-hangzhou",
        "InstanceTypeFamily": "ecs.n4",
        "OperatingSystem": "Linux"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.