Criar uma instância do banco de dados federado em um projeto

POSTAR /api/atlas/v2/groups/{groupId}/dataFederation
Contas de serviço DigestAuth

Cria uma instância do banco de dados federado no projeto especificado. Para usar esse recurso, a conta de Serviço ou a chave de API solicitante deve ter as funções de proprietário do projeto ou administrador de gráficos do projeto.

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair 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.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON 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 consulta. 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.

    O valor padrão é false.

  • pretty booleano

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

    O valor padrão é false.

    Prettyprint
  • skipRoleValidation booleano

    Sinalizador que indica se essa solicitação deve verificar se a role do IAM solicitante pode ler a partir do bucket do S3. A AWS verifica se a role pode listar os objetos no bucket antes de gravar nele. Algumas roles do IAM precisam apenas de permissões de gravação. Este sinalizador permite pular essa verificação.

    O valor padrão é false.

application/vnd.atlas.2023-01-01+json

corpo, corpo Obrigatório

Detalhes para criar uma instância do banco de dados federado no projeto especificado.

  • cloudProviderConfig objeto

    Provedor de nuvem em que essa instância de banco de dados federado está hospedada.

    Ocultar atributos cloudProviderConfig Mostrar atributos cloudProviderConfig objeto
    • AWS objeto

      Configuração para executar a Data Federation no AWS.

      Ocultar atributos aws Mostrar atributos aws objeto
      • roleId string Obrigatório

        Identificador exclusivo da função que o data lake pode usar para acessar os armazenamentos de dados.Required se especificar cloudProviderConfig.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • testS3Bucket string Obrigatório

        Nome do bucket de dados S3 que o ID de role fornecido está autorizado a acessar.Obrigatório para especificar cloudProviderConfig.

    • Azure objeto

      Configuração para executar o Data Federation no Azure.

      Ocultar atributo Azure Mostrar atributo Azure objeto
      • roleId string Obrigatório

        Identificador exclusivo da função que o Data Federation pode usar para acessar os armazenamentos de dados. Necessário se especificar cloudProviderConfig.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • GCP objeto

      Configuração para executar a Data Federation no GCP.

      Ocultar atributo gcp Mostrar atributo gcp objeto
      • roleId string Obrigatório

        Identificador exclusivo da função que o Data Federation pode usar para acessar os armazenamentos de dados. Necessário se especificar cloudProviderConfig.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

  • dataProcessRegion objeto

    Informações sobre a região do fornecedor de serviços em nuvem para a qual a instância do banco de dados federado encaminha as conexões do cliente.

    Ocultar atributos dataProcessRegion Mostrar atributos de dataProcessRegion objeto
    • cloudProvider string Obrigatório

      Nome do serviço de nuvem que hospeda a infraestrutura da Instância do Banco de Dados Federado.

      Os valores são AWS, AZURE ou GCP.

    • região string Obrigatório

      Nome da região para a qual o data lake encaminha as conexões do cliente .

      Um dos seguintes:
      ApiAtlasDataLakeAWSRegionView string AtlasDataFederationAzureRegion string AtlasDataFederationGCPRegion string

      Regiões da AWS do Atlas Data Federation .

      Os valores são SYDNEY_AUS, MUMBAI_IND, FRANKFURT_DEU, DUBLIN_IRL, LONDON_GBR, VIRGINIA_USA, OREGON_USA, SAOPAULO_BRA, MONTREAL_CAN, TOKYO_JPN, SEOUL_KOR ou SINGAPORE_SGP.

      Regiões do Azure do Atlas Data Federation .

      Os valores são VIRGINIA_USA, AMSTERDAM_NLD ou SAOPAULO_BRA.

      Regiões do GCP do Atlas Data Federation .

      Os valores são IOWA_USA ou BELGIUM_EU.

  • name string

    Etiqueta legível por humanos que identifica a instância do banco de dados federado.

  • Armazenamento objeto

    Informações de configuração para cada armazenamento de dados e seu mapeamento para bancos de dados do MongoDB Cloud.

    Ocultar atributos de armazenamento Mostrar atributos de armazenamento objeto
    • databases array[objeto]

      Array que contém os bancos de dados consultáveis e as collections para esse data lake.

      Banco de dados associado a este data lake. Os bancos de dados contêm collections e visualizações.

      Ocultar atributos de bancos de dados Mostrar atributos de bancos de dados objeto
      • collections array[objeto]

        Array de collections e fontes de dados que mapeiam para um armazenamento de dados stores .

        Uma coleção e fontes de dados que mapeiam para um armazenamento de dados stores .

        Ocultar atributos de collections Mostrar atributos de collections objeto
        • dataSources array[objeto]

          Array que contém os armazenamentos de dados que mapeiam para uma coleção para esse data lake.

          Armazenamento de dados que mapeia para uma coleção para este data lake.

          Ocultar atributos dataSources Mostrar atributos dataSources objeto
          • allowInsecure booleano

            Sinalizador que valida o esquema nas URLs especificadas. Se true, permite esquema de HTTP inseguro, não verifica a cadeia de certificado e nome de host do servidor e aceita qualquer certificado com qualquer nome de host apresentado pelo servidor. Se false, permite somente esquema de HTTPS seguro.

            O valor padrão é false.

          • collection string

            Rótulo legível por humanos que identifica a coleção no banco de dados. Para criar uma coleção de curingas (*), você deve omitir este parâmetro.

          • collectionRegex string

            Padrão regex a ser usado para criar a coleção curinga(). Para saber mais sobre a sintaxe regex, consulte Linguagem de programação Go.

          • database string

            Rótulo legível por humanos que identifica o banco de dados, que contém a coleção no cluster. Você deve omitir este parâmetro para gerar coleções curingas (*) para bancos de dados gerados dinamicamente.

          • databaseRegex string

            Padrão regex a ser usado para criar o banco de dados wildcard(). Para saber mais sobre a sintaxe regex, consulte Linguagem de programação Go.

          • datasetName string

            Rótulo legível por humanos que identifica o conjunto de dados que o Atlas gera para uma execução de pipeline de ingestão ou Arquivo Online.

          • datasetPrefix string

            Rótulo legível por humanos que corresponde aos nomes do conjunto de dados para execuções de pipeline de ingestão ou Arquivos Online.

          • defaultFormat string

            Formato de arquivo que o MongoDB Cloud usa se encontrar um arquivo sem extensão de arquivo ao pesquisar storeName.

            Os valores são .avro, .avro.bz2, .avro.gz, .bson, .bson.bz2, .bson.gz, .bsonx, .csv, .csv.bz2, .csv.gz, .json, .json.bz2, .json.gz, .orc, .parquet, .tsv, .tsv.bz2 ou .tsv.gz.

          • caminho string

            Caminho de arquivo que controla como o MongoDB Cloud procura e analisa arquivos no storeName antes de mapeá-los para uma coleção.Especifique / para capturar todos os arquivos e pastas do prefix caminho.

          • proveniênciaFieldName string

            Nome do campo que inclui a procedência dos documentos nos resultados. O MongoDB Cloud retorna campos diferentes nos resultados para cada provedor suportado.

          • storeName string

            Rótulo legível por humanos que identifica o armazenamento de dados que o MongoDB Cloud mapeia para a coleção.

          • TrimLevel integer(int32)

            Inteiro não assinado que especifica quantos campos do nome do conjunto de dados devem ser cortados da esquerda do nome do conjunto de dados antes de mapear os campos restantes para um nome de coleção curinga.

          • URLs array[string]

            URLs dos arquivos de dados acessíveis publicamente. Não é possível especificar URLs que exijam autenticação. O Atlas Data Lake cria uma partição para cada URL. Se vazio ou omitido, o Data Lake usa as URLs do armazenamento especificado no parâmetro dataSources.storeName.

        • name string

          Etiqueta legível por humanos que identifica a collection para a qual a MongoDB Cloud mapeia os dados nos armazenamentos de dados.

      • maxWildcardCollections integer(int32)

        Número máximo de coleções de curingas no banco de dados. Isso se aplica apenas a fontes de dados S3.

        O valor mínimo é 1, o valor máximo é 1000. O valor padrão é 100.

      • name string

        Rótulo legível por humanos que identifica o banco de dados para o qual o data lake mapeia os dados.

      • Visualizações array[objeto]

        Array de pipelines de agregação que se aplicam à coleção. Isso se aplica apenas a fontes de dados S3.

        Um pipeline de agregação que se aplica à coleção.

        Ocultar atributos de visualizações Mostrar atributos de visualizações objeto
        • name string

          Etiqueta legível para humanos que identifica a visualização, que corresponde a uma aggregation pipeline em uma collection.

        • gasoduto string

          Estágios do pipeline de agregação a serem aplicados à coleção de origem.

          Aggregation Pipelines
        • Fonte string

          Etiqueta legível para humanos que identifica a collection de origem para a visualização.

    • stores array[objeto]

      Array que contém os armazenamentos de dados para o data lake.

      Um dos seguintes:
      objeto s3 dls:aws objeto dls:azure objeto dls:gcp objeto atlas object objeto http objeto azure objeto gcs

Respostas

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • cloudProviderConfig objeto

      Provedor de nuvem em que essa instância de banco de dados federado está hospedada.

      Ocultar atributos cloudProviderConfig Mostrar atributos cloudProviderConfig objeto
      • AWS objeto

        Configuração para executar a Data Federation no AWS.

        Ocultar atributos aws Mostrar atributos aws objeto
        • externalId string

          Identificador exclusivo associado à função de Gerenciamento de Identidade e Acesso (IAM) que o data lake assume ao acessar os armazenamentos de dados.

        • iamAssumedRoleARN string

          Nome de recurso da Amazon (ARN) da função de gerenciamento de identidade e acesso (IAM) que o data lake assume ao acessar armazenamentos de dados.

          O comprimento mínimo é 20, o comprimento máximo é 2048.

        • iamUserARN string

          Nome do recurso da Amazon (ARN) do usuário que o data lake assume ao acessar armazenamentos de dados.

        • roleId string Obrigatório

          Identificador exclusivo da função que o data lake pode usar para acessar os armazenamentos de dados.Required se especificar cloudProviderConfig.

          O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • Azure objeto

        Configuração para executar o Data Federation no Azure.

        Ocultar atributos do Azure Mostrar atributos do Azure objeto
        • atlasAppId string

          A ID do aplicativo gerada pelo Atlas para a política de acesso do Service Principal.

        • roleId string Obrigatório

          Identificador exclusivo da função que o Data Federation pode usar para acessar os armazenamentos de dados. Necessário se especificar cloudProviderConfig.

          O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

        • ID do Principal de Serviços string

          A ID do Service Principal para o qual há uma política de acesso para o Atlas acessar os recursos do Azure.

        • ID do Inquilino string

          O ID de locatário do Azure Active Directory/ID de Entrada associado ao Principal de Serviços.

      • GCP objeto

        Configuração para executar a Data Federation no GCP.

        Ocultar atributos do gcp Mostrar atributos do gcp objeto
        • gcpServiceAccount string

          O endereço de e-mail da conta de serviço do Google Cloud Platform (GCP) criada pelo Atlas , que deve ser autorizada a permitir que o Atlas acesse o Google Cloud Storage.

        • roleId string Obrigatório

          Identificador exclusivo da função que o Data Federation pode usar para acessar os armazenamentos de dados. Necessário se especificar cloudProviderConfig.

          O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • dataProcessRegion objeto

      Informações sobre a região do fornecedor de serviços em nuvem para a qual a instância do banco de dados federado encaminha as conexões do cliente.

      Ocultar atributos dataProcessRegion Mostrar atributos de dataProcessRegion objeto
      • cloudProvider string Obrigatório

        Nome do serviço de nuvem que hospeda a infraestrutura da Instância do Banco de Dados Federado.

        Os valores são AWS, AZURE ou GCP.

      • região string Obrigatório

        Nome da região para a qual o data lake encaminha as conexões do cliente .

        Um dos seguintes:
        ApiAtlasDataLakeAWSRegionView string AtlasDataFederationAzureRegion string AtlasDataFederationGCPRegion string

        Regiões da AWS do Atlas Data Federation .

        Os valores são SYDNEY_AUS, MUMBAI_IND, FRANKFURT_DEU, DUBLIN_IRL, LONDON_GBR, VIRGINIA_USA, OREGON_USA, SAOPAULO_BRA, MONTREAL_CAN, TOKYO_JPN, SEOUL_KOR ou SINGAPORE_SGP.

        Regiões do Azure do Atlas Data Federation .

        Os valores são VIRGINIA_USA, AMSTERDAM_NLD ou SAOPAULO_BRA.

        Regiões do GCP do Atlas Data Federation .

        Os valores são IOWA_USA ou BELGIUM_EU.

    • groupId string

      String exclusiva de 24 caracteres hexadecimais que identifica o projeto.

      O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • nomes de host array[string]

      Lista que contém os nomes de host atribuídos à Instância do Banco de Dados Federado.

    • name string

      Etiqueta legível por humanos que identifica a instância do banco de dados federado.

    • privateEndpointHostnames array[objeto]

      Lista que contém os conjuntos de endpoints privados e nomes de host.

      Conjunto de endpoints privados e nomes de host.

      Ocultar atributos privateEndpointHostnames Mostrar atributos privateEndpointHostnames objeto
      • nome do host string

        Etiqueta legível por humanos que identifica o nome do host.

      • privateEndpoint string

        Etiqueta legível para humanos que identifica endpoints privados.

    • state string

      Etiqueta que indica o status da Instância do Banco de Dados Federado.

      Os valores são UNVERIFIED, ACTIVE ou DELETED.

    • Armazenamento objeto

      Informações de configuração para cada armazenamento de dados e seu mapeamento para bancos de dados do MongoDB Cloud.

      Ocultar atributos de armazenamento Mostrar atributos de armazenamento objeto
      • databases array[objeto]

        Array que contém os bancos de dados consultáveis e as collections para esse data lake.

        Banco de dados associado a este data lake. Os bancos de dados contêm collections e visualizações.

        Ocultar atributos de bancos de dados Mostrar atributos de bancos de dados objeto
        • collections array[objeto]

          Array de collections e fontes de dados que mapeiam para um armazenamento de dados stores .

          Uma coleção e fontes de dados que mapeiam para um armazenamento de dados stores .

          Ocultar atributos de collections Mostrar atributos de collections objeto
          • dataSources array[objeto]

            Array que contém os armazenamentos de dados que mapeiam para uma coleção para esse data lake.

            Armazenamento de dados que mapeia para uma coleção para este data lake.

            Ocultar atributos dataSources Mostrar atributos dataSources objeto
            • allowInsecure booleano

              Sinalizador que valida o esquema nas URLs especificadas. Se true, permite esquema de HTTP inseguro, não verifica a cadeia de certificado e nome de host do servidor e aceita qualquer certificado com qualquer nome de host apresentado pelo servidor. Se false, permite somente esquema de HTTPS seguro.

              O valor padrão é false.

            • collection string

              Rótulo legível por humanos que identifica a coleção no banco de dados. Para criar uma coleção de curingas (*), você deve omitir este parâmetro.

            • collectionRegex string

              Padrão regex a ser usado para criar a coleção curinga(). Para saber mais sobre a sintaxe regex, consulte Linguagem de programação Go.

            • database string

              Rótulo legível por humanos que identifica o banco de dados, que contém a coleção no cluster. Você deve omitir este parâmetro para gerar coleções curingas (*) para bancos de dados gerados dinamicamente.

            • databaseRegex string

              Padrão regex a ser usado para criar o banco de dados wildcard(). Para saber mais sobre a sintaxe regex, consulte Linguagem de programação Go.

            • datasetName string

              Rótulo legível por humanos que identifica o conjunto de dados que o Atlas gera para uma execução de pipeline de ingestão ou Arquivo Online.

            • datasetPrefix string

              Rótulo legível por humanos que corresponde aos nomes do conjunto de dados para execuções de pipeline de ingestão ou Arquivos Online.

            • defaultFormat string

              Formato de arquivo que o MongoDB Cloud usa se encontrar um arquivo sem extensão de arquivo ao pesquisar storeName.

              Os valores são .avro, .avro.bz2, .avro.gz, .bson, .bson.bz2, .bson.gz, .bsonx, .csv, .csv.bz2, .csv.gz, .json, .json.bz2, .json.gz, .orc, .parquet, .tsv, .tsv.bz2 ou .tsv.gz.

            • caminho string

              Caminho de arquivo que controla como o MongoDB Cloud procura e analisa arquivos no storeName antes de mapeá-los para uma coleção.Especifique / para capturar todos os arquivos e pastas do prefix caminho.

            • proveniênciaFieldName string

              Nome do campo que inclui a procedência dos documentos nos resultados. O MongoDB Cloud retorna campos diferentes nos resultados para cada provedor suportado.

            • storeName string

              Rótulo legível por humanos que identifica o armazenamento de dados que o MongoDB Cloud mapeia para a coleção.

            • TrimLevel integer(int32)

              Inteiro não assinado que especifica quantos campos do nome do conjunto de dados devem ser cortados da esquerda do nome do conjunto de dados antes de mapear os campos restantes para um nome de coleção curinga.

            • URLs array[string]

              URLs dos arquivos de dados acessíveis publicamente. Não é possível especificar URLs que exijam autenticação. O Atlas Data Lake cria uma partição para cada URL. Se vazio ou omitido, o Data Lake usa as URLs do armazenamento especificado no parâmetro dataSources.storeName.

          • name string

            Etiqueta legível por humanos que identifica a collection para a qual a MongoDB Cloud mapeia os dados nos armazenamentos de dados.

        • maxWildcardCollections integer(int32)

          Número máximo de coleções de curingas no banco de dados. Isso se aplica apenas a fontes de dados S3.

          O valor mínimo é 1, o valor máximo é 1000. O valor padrão é 100.

        • name string

          Rótulo legível por humanos que identifica o banco de dados para o qual o data lake mapeia os dados.

        • Visualizações array[objeto]

          Array de pipelines de agregação que se aplicam à coleção. Isso se aplica apenas a fontes de dados S3.

          Um pipeline de agregação que se aplica à coleção.

          Ocultar atributos de visualizações Mostrar atributos de visualizações objeto
          • name string

            Etiqueta legível para humanos que identifica a visualização, que corresponde a uma aggregation pipeline em uma collection.

          • gasoduto string

            Estágios do pipeline de agregação a serem aplicados à coleção de origem.

            Aggregation Pipelines
          • Fonte string

            Etiqueta legível para humanos que identifica a collection de origem para a visualização.

      • stores array[objeto]

        Array que contém os armazenamentos de dados para o data lake.

        Um dos seguintes:
        objeto s3 dls:aws objeto dls:azure objeto dls:gcp objeto atlas object objeto http objeto azure objeto gcs
  • 400 aplicação/json

    Solicitação inválida.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
POST /api/atlas/v2/groups/{groupId}/dataFederation 
atlas api dataFederation createGroupDataFederation --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241023001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreateGroupDataFederationApiParams{}
	sdkResp, httpResp, err := client.DataFederationApi.
		CreateGroupDataFederationWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \
  -d '{ <Payload> }'
Exemplos de solicitação 
{
  "cloudProviderConfig": {
    "aws": {
      "roleId": "32b6e34b3d91647abb20e7b8",
      "testS3Bucket": "string"
    },
    "azure": {
      "roleId": "32b6e34b3d91647abb20e7b8"
    },
    "gcp": {
      "roleId": "32b6e34b3d91647abb20e7b8"
    }
  },
  "dataProcessRegion": {
    "cloudProvider": "AWS",
    "": "SYDNEY_AUS"
  },
  "name": "string",
  "storage": {
    "databases": [
      {
        "collections": [
          {
            "dataSources": [
              {
                "allowInsecure": false,
                "collection": "string",
                "collectionRegex": "string",
                "database": "string",
                "databaseRegex": "string",
                "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
                "datasetPrefix": "string",
                "defaultFormat": ".avro",
                "path": "string",
                "provenanceFieldName": "string",
                "storeName": "string",
                "trimLevel": 42,
                "urls": [
                  "string"
                ]
              }
            ],
            "name": "string"
          }
        ],
        "maxWildcardCollections": 100,
        "name": "string",
        "views": [
          {
            "name": "string",
            "pipeline": "string",
            "source": "string"
          }
        ]
      }
    ],
    "stores": [
      {
        "name": "string",
        "provider": "s3",
        "additionalStorageClasses": [
          "STANDARD"
        ],
        "bucket": "string",
        "delimiter": "string",
        "includeTags": false,
        "prefix": "string",
        "public": false,
        "region": "US_GOV_WEST_1"
      }
    ]
  }
}
Exemplos de resposta (200) 
{
  "cloudProviderConfig": {
    "aws": {
      "externalId": "string",
      "iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
      "iamUserARN": "string",
      "roleId": "32b6e34b3d91647abb20e7b8"
    },
    "azure": {
      "atlasAppId": "string",
      "roleId": "32b6e34b3d91647abb20e7b8",
      "servicePrincipalId": "string",
      "tenantId": "string"
    },
    "gcp": {
      "gcpServiceAccount": "string",
      "roleId": "32b6e34b3d91647abb20e7b8"
    }
  },
  "dataProcessRegion": {
    "cloudProvider": "AWS",
    "": "SYDNEY_AUS"
  },
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostnames": [
    "string"
  ],
  "name": "string",
  "privateEndpointHostnames": [
    {
      "hostname": "string",
      "privateEndpoint": "string"
    }
  ],
  "state": "UNVERIFIED",
  "storage": {
    "databases": [
      {
        "collections": [
          {
            "dataSources": [
              {
                "allowInsecure": false,
                "collection": "string",
                "collectionRegex": "string",
                "database": "string",
                "databaseRegex": "string",
                "datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
                "datasetPrefix": "string",
                "defaultFormat": ".avro",
                "path": "string",
                "provenanceFieldName": "string",
                "storeName": "string",
                "trimLevel": 42,
                "urls": [
                  "string"
                ]
              }
            ],
            "name": "string"
          }
        ],
        "maxWildcardCollections": 100,
        "name": "string",
        "views": [
          {
            "name": "string",
            "pipeline": "string",
            "source": "string"
          }
        ]
      }
    ],
    "stores": [
      {
        "name": "string",
        "provider": "s3",
        "additionalStorageClasses": [
          "STANDARD"
        ],
        "bucket": "string",
        "delimiter": "string",
        "includeTags": false,
        "prefix": "string",
        "public": false,
        "region": "US_GOV_WEST_1"
      }
    ]
  }
}
Exemplos de resposta (400) 
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Exemplos de resposta (401) 
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Exemplos de resposta (403) 
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Exemplos de resposta (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Exemplos de resposta (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}