Retorna o status e os detalhes de um relatório de fatura solicitado anteriormente.
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.
Este comando é gerado automaticamente e 1 corresponde:1 ao ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-getorginvoicereport .
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api invoices getOrgInvoiceReport [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-h, --help | false | ajuda para getOrgInvoiceReport | |
--invoiceId | string | true | String única que identifica a fatura para a qual o relatório foi gerado. |
--orgId | /orgs | true | String exclusiva de 24dÃgitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas as organizações à s quais o usuário autenticado tem acesso. |
-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) |
--reportId | string | true | String exclusiva que identifica o relatório a ser recuperado. |
--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". |
Opções herdadas
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 . |
Exemplos
atlas api invoices getOrgInvoiceReport --version 2025-03-12 --invoiceId [invoiceId] --orgId 4888442a3354817a7320eb61 --reportId [reportId]