Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / /

atlas API queryShapeInsights getGroupClusterQueryShapeInsightDetails

Visualização pública: forneça comentários: Retorna o resumo de metadados e estatísticas para um determinado hash de forma de query.

O subcomando da API do Atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça comentários em https://feedback.mongodb.com/forums/930808-atlas-cli). Os recursos 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 endpoint da API fornecido.

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

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

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

--clusterName

string

true

Etiqueta legível por humanos que identifica o cluster.

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

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

--pretty

false

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

--processIds

mongod

false

ProcessIds dos quais recuperar estatísticas da forma de query . Um processId é uma combinação de host e porta que atende ao processo do MongoDB . O host deve ser o nome de host, FQDN, endereço IPv4 ou endereço 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. Para incluir vários processIds, passe o parâmetro várias vezes, delimitados por um sinal tipográfico (&) entre cada processId.

--queryShapeHash

string

true

Um SHA256 hash de uma forma de query, gerado por comandos do MongoDB como $queryStats e $explain ou registros de query lentos.

--since

int

false

Data e hora a partir das quais recuperar as estatísticas da forma de query . Este parâmetro expressa seu valor no número de milissegundos decorridos desde a [época UNIX](https://en.wikiped.org/wiki/Unix_time).

  • Se você não especificar o parâmetro until, o endpoint retornará os dados que abrangem o valor since e a hora atual.

  • Se você não especificar nem os parâmetros desde nem até, o ponto de extremidade retornará dados das 24 horas anteriores.

--until

int

false

Data e hora até a qual recuperar as estatísticas da forma de query . Este parâmetro expressa seu valor no número de milissegundos decorridos desde a [UNIX epoch](https://en.wikiped.org/wiki/Unix_time).

  • Se você especificar o parâmetro until, deverá especificar o parâmetro since.

  • Se você não especificar nem os parâmetros desde nem até, o ponto de extremidade retornará dados das 24 horas anteriores.

--version

string

false

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

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 queryShapeInsights getGroupClusterQueryShapeInsightDetails --version 2025-03-12 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --queryShapeHash [queryShapeHash]

Voltar

queryShapeInsights

Nesta página