Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

atlas api shardingInsights getShardMetricMeasurements

Retorna a série temporal das medições solicitadas para um fragmento do cluster fragmentado 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.

The series average the readings of the shard's member processes selected by nodeType. Responds with a 404 only when no shard with the given replicaSetName exists in the cluster; a shard that exists but has no readings yet returns series of null data points. Each series carries one data point per granularity interval, starting at start and not passing end. A data point's value is null when MongoDB Cloud has no reading for that interval; this includes the first minutes after a cluster or shard is created, before its metrics are collected, so null must not be read as zero load. Set period, or set both start and end; when neither is set, the response covers the last hour. A request whose window and granularity would produce more than 1000 data points per series is rejected.

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

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

Sintaxe do comando

atlas api shardingInsights getShardMetricMeasurements [options]
Nome
Tipo
Obrigatório
Descrição

--clusterName

string

true

Etiqueta legível por humanos que identifica o cluster.

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

false

Interval between consecutive data points, in ISO 8601 duration format. If omitted, MongoDB Cloud chooses the resolution from the width of the window.

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

--m

m

false

One or more measurements to return. If omitted, the resource returns all measurements. To specify multiple values for m, repeat the m parameter for each value.

--tipo de nó

string

false

Membros do fragmento cujas leituras são incluídas na média da série do fragmento.

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

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

--pretty

false

Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

--replicaSetName

string

true

Rótulo legível por humanos que identifica o fragmento, como o nome do conjunto de réplicas de seus membros.

--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 os pontos de extremidade da API do Atlas [opções: "2025-03-12"]. Se não for definido pelo usuário, o padrão será a versão mais recente ou o valor de configuração api_version do perfil, se definido. Esse valor padroniza para "2025-03-12".

Nome
Tipo
Obrigatório
Descrição

-P, --profile

string

false

Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

atlas api shardingInsights getShardMetricMeasurements --version 2025-03-12 --clusterName [clusterName] --granularity PT1M --groupId 32b6e34b3d91647abb20e7b8 --period PT10H --replicaSetName atlas-12vorz-shard-0