Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / / /

atlas api monitoringAndLogs listIndexMetrics

Visualização pública: forneça feedback em: retorna as métricas de índice do Atlas Search dentro da faixa de tempo especificada para um namespace no processo especificado.

Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-e-Logs/operation/listIndexMetrics.

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

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

--collectionName

string

true

Etiqueta legível para humanos que identifica a collection.

--databaseName

string

true

Rótulo legível por humanos que identifica o banco de dados.

--end

string

false

Data e hora em que o MongoDB Cloud para de reportar as métricas. Este parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC. Insira esee parâmetro quando você não definir o período.

--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.

--granularity

string

true

Duração que especifica o intervalo no qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC.

--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 listIndexMetrics

--metrics

array de strings

true

Lista que contém as medições que o MongoDB Atlas relata para a série de dados associada.

--output

string

false

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

--output-file

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)

--period

string

false

Duração durante a qual o Atlas relata as métricas. Este parâmetro expressa seu valor no formato de duração ISO 8601 em UTC. Inclua este parâmetro se você não configurar o início e término.

--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.

--start

string

false

Data e hora em que o MongoDB Cloud começa a relatar as métricas. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC. Inclua esse parâmetro se você não definir o ponto.

--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

Execute o comando abaixo.

atlas api monitoringAndLogs listIndexMetrics --version 2023-01-01 --collectionName mycoll --databaseName mydb --envelope false --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --metrics [metrics] --period PT10H --processId my.host.name.com:27017

Nesta página