Retorna todos os estados de restauração no nível da coleção para uma tarefa de restauração de coleção do 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.
Observação: se a tarefa de restaurar estiver no estado INITIALIZING, este ponto de extremidade retornará uma lista vazia porque os estados de nível de coleção ainda não foram criados.
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-listgroupclustercollectionrestorejobcollections.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api cloudBackups listRestoreJobCollections [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Etiqueta legível por humanos que identifica o cluster com a tarefa de restaurar a coleção que você deseja retornar. |
--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 listRestoreJobCollections | |
--itemsPerPage | int | false | Número de itens que a resposta retorna por página. |
--jobId | string | true | string exclusiva de dígitos hexadecimais 24que identifica a tarefa de restaurar a coleção. |
-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) |
--pageNum | int | false | Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. | |
--sourceNamespace | db.collection | false | Namespace de origem para filtrar por (por exemplo, db.coleção). |
--state | string | false | Estado de nível de coleção para filtrar. |
--targetNamespace | db.collection | false | Namespace de destino para filtrar por (por exemplo, db.coleção). |
--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", "preview"]. 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 tem como padrão "preview". |
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 cloudBackups listRestoreJobCollections --version preview --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --jobId [jobId]