Usando a API Application Discovery Service para consultar itens de configuração descobertos - AWS Application Discovery Service
Usar a ação DescribeConfigurationsUsar a ação ListConfigurationsConsistência eventual

AWS O Application Discovery Service não está mais aberto a novos clientes. Como alternativa, use AWS Transform o que fornece recursos semelhantes. Para obter mais informações, consulte Alteração de disponibilidade AWS do Application Discovery Service.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Usando a API Application Discovery Service para consultar itens de configuração descobertos

Um item de configuração é um ativo de TI que foi descoberto em seu data center por um agente ou por uma importação. Ao usar AWS Application Discovery Service (Application Discovery Service), você usa a API para especificar filtros e consultar itens de configuração específicos para ativos de servidor, aplicativo, processo e conexão. Para obter informações sobre a API, consulte Application Discovery Service API Reference.

As tabelas nas seções a seguir listam os filtros de entrada e as opções de classificação de saída disponíveis para duas ações do Application Discovery Service:

  • DescribeConfigurations

  • ListConfigurations

As opções de filtragem e classificação são organizadas pelo tipo de ativo ao qual se aplicam (servidor, aplicativo, processo ou conexão).

Importante

Os resultados retornados por DescribeConfigurationsListConfigurations,, e StartExportTask podem não conter atualizações recentes. Para obter mais informações, consulte Consistência eventual na API AWS Application Discovery Service.

Usar a ação DescribeConfigurations

A DescribeConfigurations ação recupera atributos para uma lista de configurações IDs. Todos os fornecidos IDs devem ser do mesmo tipo de ativo (servidor, aplicativo, processo ou conexão). Os campos de saída são específicos ao tipo de ativo selecionado. Por exemplo, a saída de um item da configuração do servidor inclui uma lista de atributos sobre o servidor, como nome do host, o sistema operacional e o número de placas de rede. Para obter mais informações sobre a sintaxe do comando, consulte DescribeConfigurations.

A ação DescribeConfigurations não é compatível com filtragem.

Campos de saída para DescribeConfigurations

As tabelas a seguir, organizadas por tipo de ativo, listam os campos de saída compatíveis da ação DescribeConfigurations. Os marcados como obrigatórios estão sempre presentes na saída.

Ativos do servidor

Campo Obrigatório
server.agentId
server.applications
server.applications.hasMoreValues
server.configurationId x
server.cpuType
server.hostName
server.hypervisor
server.networkInterfaceInfo
server.networkInterfaceInfo.hasMoreValues
server.osName
server.osVersion
server.tags
server.tags.hasMoreValues
server.timeOfCreation x
server.type
server.performance.avgCpuUsagePct
server.performance.avgDiskReadIOPS
server.performance.avgDiskReadsPerSecondInKB
server.performance.avgDiskWriteIOPS
server.performance.avgDiskWritesPerSecondInKB
server.performance.avgFreeRAMInKB
server.performance.avgNetworkReadsPerSecondInKB
server.performance.avgNetworkWritesPerSecondInKB
server.performance.maxCpuUsagePct
server.performance.maxDiskReadIOPS
server.performance.maxDiskReadsPerSecondInKB
server.performance.maxDiskWriteIOPS
server.performance.maxDiskWritesPerSecondInKB
server.performance.maxNetworkReadsPerSecondInKB
server.performance.maxNetworkWritesPerSecondInKB
server.performance.minFreeRAMInKB
server.performance.numCores
server.performance.numCpus
server.performance.numDisks
server.performance.numNetworkCards
server.performance.totalRAMInKB

Processar ativos

Campo Obrigatório
process.commandLine
process.configurationId x
process.name
process.path
process.timeOfCreation x

Ativos do aplicativo

Campo Obrigatório
application.configurationId x
application.description
application.lastModifiedTime x
application.name x
application.serverCount x
application.timeOfCreation x

Usar a ação ListConfigurations

A ação ListConfigurations recupera uma lista de itens de configuração de acordo com os critérios especificados em um filtro. Para obter mais informações sobre a sintaxe do comando, consulte ListConfigurations.

Campos de saída para ListConfigurations

As tabelas a seguir, organizadas por tipo de ativo, listam os campos de saída compatíveis da ação ListConfigurations. Os marcados como obrigatórios estão sempre presentes na saída.

Ativos do servidor

Campo Obrigatório
server.configurationId x
server.agentId
server.hostName
server.osName
server.osVersion
server.timeOfCreation x
server.type

Processar ativos

Campo Obrigatório
process.commandLine
process.configurationId x
process.name
process.path
process.timeOfCreation x
server.agentId
server.configurationId x

Ativos do aplicativo

Campo Obrigatório
application.configurationId x
application.description
application.name x
application.serverCount x
application.timeOfCreation x
application.lastModifiedTime x

Ativos de conexão

Campo Obrigatório
connection.destinationIp x
connection.destinationPort x
connection.ipVersion x
connection.latestTimestamp x
connection.occurrence x
connection.sourceIp x
connection.transportProtocol
destinationProcess.configurationId
destinationProcess.name
destinationServer.configurationId
destinationServer.hostName
sourceProcess.configurationId
sourceProcess.name
sourceServer.configurationId
sourceServer.hostName
Filtros compatíveis para ListConfigurations

As tabelas a seguir, organizadas por tipo de ativo, listam os filtros compatíveis para a ação ListConfigurations. Filtros e valores estão em um key/value relacionamento definido por uma das condições lógicas suportadas. A saída dos filtros indicados pode ser classificada.

Ativos do servidor

Filtro

Condições compatíveis

Valores com suporte

Classificação compatível
server.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • Qualquer ID de configuração de servidor válido

 Nenhum
server.hostName

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
server.osName

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
server.osVersion

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
server.agentId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • String

 Nenhum
server.connectorId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • String

 Nenhum
server.type

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

 String com um dos seguintes valores:

  • EC2

  • OUTRO

  • VMWARE_VM

  • VMWARE_HOST

  • VMWARE_VM_TEMPLATE

 Nenhum
server.vmWareInfo.morefId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.vmWareInfo.vcenterId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.vmWareInfo.hostId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.networkInterfaceInfo.portGroupId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.networkInterfaceInfo.portGroupName

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.networkInterfaceInfo.virtualSwitchName

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.networkInterfaceInfo.ipAddress

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.networkInterfaceInfo.macAddress

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.performance.avgCpuUsagePct

  • GE

  • LE

  • GT

  • LT

  • Porcentagem

 Nenhum
server.performance.totalDiskFreeSizeInKB

  • GE

  • LE

  • GT

  • LT

  • Duplo

 Nenhum
server.performance.avgFreeRAMInKB

  • GE

  • LE

  • GT

  • LT

  • Duplo

 Nenhum
server.tag.value

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.tag.key

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.application.name

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.application.description

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum
server.application.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • Qualquer ID de configuração de aplicativo válido

Nenhum
server.process.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ProcessId

Nenhum

server.process.name

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

Nenhum
server.process.commandLine

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

 Nenhum

Ativos do aplicativo

Filtro

Condições compatíveis

Valores com suporte

Classificação compatível
application.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ApplicationId

 Nenhum
application.name

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
application.description

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
application.serverCount Filtragem compatível. Filtragem compatível.

  • ASC

  • DESC
application.timeOfCreation Filtragem compatível. Filtragem compatível.

  • ASC

  • DESC
application.lastModifiedTime Filtragem compatível. Filtragem compatível.

  • ASC

  • DESC
server.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ServerId

 Nenhum

Processar ativos

Filtro

Condições compatíveis

Valores com suporte

Classificação compatível
process.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ProcessId

process.name

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
process.commandLine

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
server.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ServerId
server.hostName

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
server.osName

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
server.osVersion

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
server.agentId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

Ativos de conexão

Filtro

Condições compatíveis

Valores com suporte

Classificação compatível
connection.sourceIp

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • IP

  • ASC

  • DESC
connection.destinationIp

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • IP

  • ASC

  • DESC
connection.destinationPort

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • Inteiro

  • ASC

  • DESC
sourceServer.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ServerId
sourceServer.hostName

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
destinationServer.osName

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
destinationServer.osVersion

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
destinationServer.agentId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String
sourceProcess.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ProcessId
sourceProcess.name

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
sourceProcess.commandLine

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
destinationProcess.configurationId

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • ProcessId
destinationProcess.name

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC
destinationprocess.commandLine

  • EQUALS

  • NOT_EQUALS

  • EQ

  • NE

  • CONTAINS

  • NOT_CONTAINS

  • String

  • ASC

  • DESC

Consistência eventual na API AWS Application Discovery Service

Eventualmente, as operações de atualização a seguir são consistentes. As atualizações podem não estar imediatamente visíveis para as operações de leitura StartExportTaskDescribeConfigurations, ListConfigurationse.

Sugestões para gerenciar a consistência eventual:

  • Ao invocar as operações de leitura StartExportTaskDescribeConfigurations, ou ListConfigurations(ou seus AWS CLI comandos correspondentes), use um algoritmo de recuo exponencial para permitir tempo suficiente para que qualquer operação de atualização anterior se propague pelo sistema. Para fazer isso, execute a operação de leitura repetidamente, começando com um tempo de espera de dois segundos e aumentando gradualmente até cinco minutos de tempo de espera.

  • Adicione o tempo de espera entre as operações subsequentes, mesmo que uma operação de atualização retorne uma resposta 200 - OK. Aplique um algoritmo de recuo exponencial começando com alguns segundos de espera e aumente gradualmente até cerca de cinco minutos de espera.