Menu Docs
Página inicial do Docs
/ /

atlas api monitoringAndLogs listHostFtsMetrics

Retorna todos os tipos de métrica do Atlas Search disponíveis para um processo no projeto especificado.

O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. As funcionalidades da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do ponto de extremidade da API fornecido.

Você deve ter a role Somente leitura do projeto ou superior para visualizar os tipos de métricas do Atlas Search.

Este comando é gerado automaticamente e corresponde 1:1 com o ponto de extremidade da API do Atlashttps://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-listgrouphostftsmetrics.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe do comando
atlas api monitoringAndLogs listHostFtsMetrics [options]
Nome
Tipo
Obrigatório
Descrição

--envelope

envelope

false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

--groupId

string

true

Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar todos os projetos aos quais o usuário autenticado tem acesso.

AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

-h, --help

false

ajuda para listHostFtsMetrics

-o, --output

string

false

formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".

--outputFile

string

false

no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip)

--processId

string

true

Combinação de nome de host e porta IANA que atende ao processo do MongoDB. O host deve ser o nome do host, o nome de domínio totalmente qualificado (FQDN) ou o endereço de protocolo da Internet (IPv4 ou IPv6) do host que executa o processo do MongoDB (mongod ou mongos). A porta deve ser a porta IANA na qual o processo do MongoDB escuta as solicitações.

--version

string

false

Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01".

Nome
Tipo
Obrigatório
Descrição

-P, --profile

string

false

atlas api monitoringAndLogs listHostFtsMetrics --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --processId my.host.name.com:27017

Voltar

listGroupProcesses

Nesta página