Actualizar una instancia de base de datos federada en un proyecto

PATCH /api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName}
Cuentas de servicio Autorización de resumen

Actualiza los detalles de una instancia federada de base de datos en el Proyecto especificado. Para utilizar este recurso, la clave de API o la cuenta de servicio que realiza la solicitud debe tener el rol de propietario del proyecto o un rol superior.

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • tenantName string Requerido

    Etiqueta legible por humanos que identifica la instancia federada de base de datos que se va a actualizar.

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

    El valor por defecto es false.

    Impresión bonita
  • skipRoleValidation booleano Requerido

    Indicador que indica si esta solicitud debe comprobar que el rol de IAM solicitante pueda leer el bucket S3. AWS verifica si el rol puede listar los objetos en el bucket antes de escribir en él. Algunas IAM roles solo necesitan permisos de escritura. Esta bandera te permite omitir esa comprobación.

aplicación/json

Cuerpo Requerido

Detalles de una base de datos federada por actualizar en el proyecto especificado.

  • cloudProviderConfig Objeto

    Proveedor de nube donde se aloja esta instancia federada de base de datos.

    Ocultar los atributos de cloudProviderConfig Mostrar atributos cloudProviderConfig Objeto
    • aws Objeto

      Configuración para ejecutar Data Federation en AWS.

      Ocultar atributos de AWS Mostrar atributos de AWS Objeto
      • roleId string Requerido

        Identificador único del rol que el lago de datos puede usar para acceder a los almacenes de datos. Se requiere si se especifica cloudProviderConfig.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • testS3Bucket string Requerido

        Nombre del depósito de datos S3 al que el ID de rol proporcionado está autorizado a acceder. Obligatorio si se especifica cloudProviderConfig.

    • azur Objeto

      Configuración para ejecutar Data Federation en Azure.

      Ocultar atributo azure Mostrar atributo azul Objeto
      • roleId string Requerido

        Identificador único del rol que Data Federation puede utilizar para acceder a los almacenes de datos. Obligatorio si se especifica cloudProviderConfig.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • gcp Objeto

      Configuración para ejecutar la federación de datos en GCP.

      Ocultar atributo gcp Mostrar atributo de gcp Objeto
      • roleId string Requerido

        Identificador único del rol que Data Federation puede utilizar para acceder a los almacenes de datos. Obligatorio si se especifica cloudProviderConfig.

        El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • dataProcessRegion Objeto

    Información sobre la región del proveedor de nube a la que la instancia federada de base de datos enruta las conexiones de los clientes.

    Ocultar atributos dataProcessRegion Mostrar atributos de dataProcessRegion Objeto
    • Proveedor de la nube string Requerido

      Nombre del servicio en la nube que hospeda la infraestructura de la instancia federada de base de datos.

      Los valores son AWS, AZURE o GCP.

    • region string Requerido

      Nombre de la región a la que el lago de datos enruta las conexiones de los clientes.

      Uno de:
      Cadena ApiAtlasDataLakeAWSRegionView AtlasDataFederationAzureRegion string AtlasDataFederationGCPRegion string

      Regiones AWS de Atlas Data Federation.

      Los valores son SYDNEY_AUS, MUMBAI_IND, FRANKFURT_DEU, DUBLIN_IRL, LONDON_GBR, VIRGINIA_USA, OREGON_USA, SAOPAULO_BRA, MONTREAL_CAN, TOKYO_JPN, SEOUL_KOR o SINGAPORE_SGP.

      Regiones de Azure de Atlas Data Federation.

      Los valores son VIRGINIA_USA, AMSTERDAM_NLD o SAOPAULO_BRA.

      Regiones GCP de la Federación de Datos Atlas.

      Los valores son IOWA_USA o BELGIUM_EU.

  • Nombre string

    Etiqueta legible por humanos que identifica la instancia federada de base de datos.

  • Almacenamiento Objeto

    Información de configuración para cada almacén de datos y su mapeo a las bases de datos de MongoDB Cloud.

    Ocultar atributos de almacenamiento Mostrar atributos de almacenamiento Objeto
    • databases arreglo[objeto]

      Arreglo que contiene las bases de datos y colecciones consultables para este lago de datos.

      Ocultar los atributos de las bases de datos Mostrar atributos de bases de datos Objeto

      Base de datos asociada con este lago de datos. Las bases de datos contienen colecciones y vistas.

      • collections arreglo[objeto]

        Matriz de colecciones y fuentes de datos que se asignan a un almacén de datos stores.

        Ocultar atributos de colecciones Mostrar atributos de colecciones Objeto

        Una colección y fuentes de datos que se asignan a un almacén de datos stores.

        • fuentes de datos arreglo[objeto]

          Arreglo que contiene los almacenes de datos que mapean a una colección para este lago de datos.

          Ocultar atributos de fuentes de datos Mostrar atributos de fuentes de datos Objeto

          Almacenamiento de datos que se asigna a una colección para este lago de datos.

          • allowInsecure booleano

            Marca que valida el esquema en las URL especificadas. Si es true, permite el esquema HTTP inseguro, no verifica la cadena de certificados ni el nombre de host del servidor y acepta cualquier certificado con cualquier nombre de host presentado por el servidor. Si es false, solo permite el esquema HTTPS seguro.

            El valor por defecto es false.

          • Colección string

            Etiqueta legible que identifica la colección en la base de datos. Para crear una colección con comodín (*), debe omitir este parámetro.

          • collectionRegex string

            Patrón de expresiones regulares para utilizar en la creación de la colección comodín (*). Para obtener más información sobre la sintaxis regex, consulta Lenguaje de programación Go.

          • database string

            Etiqueta legible por humanos que identifica la base de datos, la cual contiene la colección en el clúster. Debe omitir este parámetro para generar colecciones comodín (*) para bases de datos generadas dinámicamente.

          • databaseRegex string

            Patrón de expresiones regulares a utilizar para crear la base de datos de comodines (*). Para obtener más información sobre la sintaxis regex, consulta Lenguaje de programación Go.

          • datasetName string

            Etiqueta legible por humanos que identifica el conjunto de datos que Atlas genera para una ejecución del pipeline de ingestión o fichero en linea.

          • datasetPrefix string

            Etiqueta legible por humanos que coincide con los nombres del conjunto de datos para las ejecuciones de los pipelines de ingestión o Ficheros en línea.

          • formato predeterminado string

            Formato de archivo que MongoDB Cloud utiliza si encuentra un archivo sin extensión de archivo durante la búsqueda de storeName.

            Los valores son .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 o .tsv.gz.

          • ruta string

            Ruta de archivo que controla cómo MongoDB Cloud busca y analiza archivos en storeName antes de asignarlos a una colección. Especifique / para capturar todos los archivos y carpetas de la prefix ruta.

          • nombreDelCampoDeProcedencia string

            Nombre del campo que incluye la procedencia de los documentos en los resultados. MongoDB Cloud devuelve diferentes campos en los resultados para cada proveedor compatible.

          • storeName string

            Etiqueta legible por humanos que identifica el almacén de datos que MongoDB Cloud asigna a la colección.

          • nivel de recorte integer(int32)

            Entero sin signo que especifica cuántos campos del nombre del conjunto de datos se deben recortar desde la izquierda del nombre del conjunto de datos antes de asignar los campos restantes a un nombre de colección comodín.

          • urls array[string]

            URLs de los archivos de datos accesibles públicamente. No se pueden especificar URLs que requieran autenticación. Atlas Data Lake crea una partición para cada URL. Si está vacío o no se especifica, Data Lake utiliza las URL de la tienda especificada en el parámetro dataSources.storeName.

        • Nombre string

          etiqueta legible por humanos que identifica la colección a la que MongoDB Cloud asigna los datos en los almacenes de datos.

      • Colecciones de comodines máximos integer(int32)

        Número máximo de colecciones de comodines en la base de datos. Esto solo aplica a las fuentes de datos S3.

        El valor mínimo es 1, el valor máximo es 1000. El valor predeterminado es 100.

      • Nombre string

        Etiqueta legible por humanos que identifica la base de datos a la que el lago de datos asigna los datos.

      • Vistas arreglo[objeto]

        Matriz de canales de agregación que se aplican a la colección. Esto solo aplica a las fuentes de datos S3.

        Ocultar atributos de vistas Mostrar atributos de vistas Objeto

        Un pipeline de agregación que se aplica a la colección.

        • Nombre string

          Etiqueta legible por humanos que identifica la vista, la cual corresponde a una pipeline de agregación en una colección.

        • pipeline string

          Etapas del pipeline de agregación a aplicar a la colección de origen.

          Pipeline de agregación
        • Origen string

          Etiqueta legible por humanos que identifica la colección de origen de la vista.

    • stores arreglo[objeto]

      Matriz que contiene los almacenes de datos para el lago de datos.

      Uno de:
      s3 objeto objeto dls:aws dls:azure objeto dls:gcp objeto atlas object http objeto azure objeto gcs objeto

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • cloudProviderConfig Objeto

      Proveedor de nube donde se aloja esta instancia federada de base de datos.

      Ocultar los atributos de cloudProviderConfig Mostrar atributos cloudProviderConfig Objeto
      • aws Objeto

        Configuración para ejecutar Data Federation en AWS.

        Ocultar atributos de AWS Mostrar atributos de AWS Objeto
        • externalId string

          Identificador único asociado con el rol de Gestión de Identidad y Acceso (IAM) que el lago de datos asume al acceder a los almacenes de datos.

        • iamAssumedRoleARN string

          Nombre de recurso de Amazon (ARN) de la función de administración de identidad y acceso (IAM) que asume el lago de datos al acceder a los almacenes de datos.

          La longitud mínima es de 20, la longitud máxima es de 2048.

        • iamUserARN string

          Nombre de recurso de Amazon (ARN) del usuario que el data lake asume cuando accede a los data stores.

        • roleId string Requerido

          Identificador único del rol que el lago de datos puede usar para acceder a los almacenes de datos. Se requiere si se especifica cloudProviderConfig.

          El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • azur Objeto

        Configuración para ejecutar Data Federation en Azure.

        Ocultar atributos de Azure Mostrar atributos de azure Objeto
        • atlasAppId string

          La ID de la aplicación generada por Atlas para la política de acceso del Service Principal.

        • roleId string Requerido

          Identificador único del rol que Data Federation puede utilizar para acceder a los almacenes de datos. Obligatorio si se especifica cloudProviderConfig.

          El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

        • IdPrincipalDeServicio string

          El identificador de la entidad de servicio para la que existe una política de acceso para que Atlas acceda a los recursos de Azure.

        • ID de inquilino string

          El ID de inquilino de Azure Active Directory/Entra ID asociado con el principal de servicio.

      • gcp Objeto

        Configuración para ejecutar la federación de datos en GCP.

        Ocultar atributos de GCP Mostrar atributos de gcp Objeto
        • gcpServiceAccount string

          La dirección de correo electrónico de la cuenta de servicio de Google Cloud Platform (GCP) creada por Atlas, la cual debe estar autorizada para permitir que Atlas acceda al Almacenamiento de Google Cloud.

        • roleId string Requerido

          Identificador único del rol que Data Federation puede utilizar para acceder a los almacenes de datos. Obligatorio si se especifica cloudProviderConfig.

          El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • dataProcessRegion Objeto

      Información sobre la región del proveedor de nube a la que la instancia federada de base de datos enruta las conexiones de los clientes.

      Ocultar atributos dataProcessRegion Mostrar atributos de dataProcessRegion Objeto
      • Proveedor de la nube string Requerido

        Nombre del servicio en la nube que hospeda la infraestructura de la instancia federada de base de datos.

        Los valores son AWS, AZURE o GCP.

      • region string Requerido

        Nombre de la región a la que el lago de datos enruta las conexiones de los clientes.

        Uno de:
        Cadena ApiAtlasDataLakeAWSRegionView AtlasDataFederationAzureRegion string AtlasDataFederationGCPRegion string

        Regiones AWS de Atlas Data Federation.

        Los valores son SYDNEY_AUS, MUMBAI_IND, FRANKFURT_DEU, DUBLIN_IRL, LONDON_GBR, VIRGINIA_USA, OREGON_USA, SAOPAULO_BRA, MONTREAL_CAN, TOKYO_JPN, SEOUL_KOR o SINGAPORE_SGP.

        Regiones de Azure de Atlas Data Federation.

        Los valores son VIRGINIA_USA, AMSTERDAM_NLD o SAOPAULO_BRA.

        Regiones GCP de la Federación de Datos Atlas.

        Los valores son IOWA_USA o BELGIUM_EU.

    • ID del grupo string

      Cadena de caracteres hexadecimales 24única que identifica el proyecto.

      El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • Nombres de host array[string]

      Lista que contiene los nombres de host asignados a la instancia federada de base de datos.

    • Nombre string

      Etiqueta legible por humanos que identifica la instancia federada de base de datos.

    • privateEndpointHostnames arreglo[objeto]

      Lista que contiene los conjuntos de nodos privados y nombres de host.

      Ocultar atributos privateEndpointHostnames Mostrar atributos de privateEndpointHostnames Objeto

      Conjunto de nodos privados y nombres de host.

      • Nombre del host string

        Etiqueta legible por humanos que identifica el nombre del host.

      • Nodo privado string

        Etiqueta legible por humanos que identifica el endpoint privado.

    • Estado string

      Etiqueta que indica el estado de la instancia federada de base de datos.

      Los valores son UNVERIFIED, ACTIVE o DELETED.

    • Almacenamiento Objeto

      Información de configuración para cada almacén de datos y su mapeo a las bases de datos de MongoDB Cloud.

      Ocultar atributos de almacenamiento Mostrar atributos de almacenamiento Objeto
      • databases arreglo[objeto]

        Arreglo que contiene las bases de datos y colecciones consultables para este lago de datos.

        Ocultar los atributos de las bases de datos Mostrar atributos de bases de datos Objeto

        Base de datos asociada con este lago de datos. Las bases de datos contienen colecciones y vistas.

        • collections arreglo[objeto]

          Matriz de colecciones y fuentes de datos que se asignan a un almacén de datos stores.

          Ocultar atributos de colecciones Mostrar atributos de colecciones Objeto

          Una colección y fuentes de datos que se asignan a un almacén de datos stores.

          • fuentes de datos arreglo[objeto]

            Arreglo que contiene los almacenes de datos que mapean a una colección para este lago de datos.

            Ocultar atributos de fuentes de datos Mostrar atributos de fuentes de datos Objeto

            Almacenamiento de datos que se asigna a una colección para este lago de datos.

            • allowInsecure booleano

              Marca que valida el esquema en las URL especificadas. Si es true, permite el esquema HTTP inseguro, no verifica la cadena de certificados ni el nombre de host del servidor y acepta cualquier certificado con cualquier nombre de host presentado por el servidor. Si es false, solo permite el esquema HTTPS seguro.

              El valor por defecto es false.

            • Colección string

              Etiqueta legible que identifica la colección en la base de datos. Para crear una colección con comodín (*), debe omitir este parámetro.

            • collectionRegex string

              Patrón de expresiones regulares para utilizar en la creación de la colección comodín (*). Para obtener más información sobre la sintaxis regex, consulta Lenguaje de programación Go.

            • database string

              Etiqueta legible por humanos que identifica la base de datos, la cual contiene la colección en el clúster. Debe omitir este parámetro para generar colecciones comodín (*) para bases de datos generadas dinámicamente.

            • databaseRegex string

              Patrón de expresiones regulares a utilizar para crear la base de datos de comodines (*). Para obtener más información sobre la sintaxis regex, consulta Lenguaje de programación Go.

            • datasetName string

              Etiqueta legible por humanos que identifica el conjunto de datos que Atlas genera para una ejecución del pipeline de ingestión o fichero en linea.

            • datasetPrefix string

              Etiqueta legible por humanos que coincide con los nombres del conjunto de datos para las ejecuciones de los pipelines de ingestión o Ficheros en línea.

            • formato predeterminado string

              Formato de archivo que MongoDB Cloud utiliza si encuentra un archivo sin extensión de archivo durante la búsqueda de storeName.

              Los valores son .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 o .tsv.gz.

            • ruta string

              Ruta de archivo que controla cómo MongoDB Cloud busca y analiza archivos en storeName antes de asignarlos a una colección. Especifique / para capturar todos los archivos y carpetas de la prefix ruta.

            • nombreDelCampoDeProcedencia string

              Nombre del campo que incluye la procedencia de los documentos en los resultados. MongoDB Cloud devuelve diferentes campos en los resultados para cada proveedor compatible.

            • storeName string

              Etiqueta legible por humanos que identifica el almacén de datos que MongoDB Cloud asigna a la colección.

            • nivel de recorte integer(int32)

              Entero sin signo que especifica cuántos campos del nombre del conjunto de datos se deben recortar desde la izquierda del nombre del conjunto de datos antes de asignar los campos restantes a un nombre de colección comodín.

            • urls array[string]

              URLs de los archivos de datos accesibles públicamente. No se pueden especificar URLs que requieran autenticación. Atlas Data Lake crea una partición para cada URL. Si está vacío o no se especifica, Data Lake utiliza las URL de la tienda especificada en el parámetro dataSources.storeName.

          • Nombre string

            etiqueta legible por humanos que identifica la colección a la que MongoDB Cloud asigna los datos en los almacenes de datos.

        • Colecciones de comodines máximos integer(int32)

          Número máximo de colecciones de comodines en la base de datos. Esto solo aplica a las fuentes de datos S3.

          El valor mínimo es 1, el valor máximo es 1000. El valor predeterminado es 100.

        • Nombre string

          Etiqueta legible por humanos que identifica la base de datos a la que el lago de datos asigna los datos.

        • Vistas arreglo[objeto]

          Matriz de canales de agregación que se aplican a la colección. Esto solo aplica a las fuentes de datos S3.

          Ocultar atributos de vistas Mostrar atributos de vistas Objeto

          Un pipeline de agregación que se aplica a la colección.

          • Nombre string

            Etiqueta legible por humanos que identifica la vista, la cual corresponde a una pipeline de agregación en una colección.

          • pipeline string

            Etapas del pipeline de agregación a aplicar a la colección de origen.

            Pipeline de agregación
          • Origen string

            Etiqueta legible por humanos que identifica la colección de origen de la vista.

      • stores arreglo[objeto]

        Matriz que contiene los almacenes de datos para el lago de datos.

        Uno de:
        s3 objeto objeto dls:aws dls:azure objeto dls:gcp objeto atlas object http objeto azure objeto gcs objeto
  • 400 aplicación/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
  • 500 aplicación/json

    Error interno del servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.
PATCH /api/atlas/v1.0/groups/{groupId}/dataFederation/{tenantName} 
curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/dataFederation/{tenantName}?skipRoleValidation=true' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"cloudProviderConfig":{"aws":{"roleId":"32b6e34b3d91647abb20e7b8","testS3Bucket":"string"},"azure":{"roleId":"32b6e34b3d91647abb20e7b8"},"gcp":{"roleId":"32b6e34b3d91647abb20e7b8"}},"dataProcessRegion":{"cloudProvider":"AWS","region":"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"}]}}'
Solicitar ejemplos 
{
  "cloudProviderConfig": {
    "aws": {
      "roleId": "32b6e34b3d91647abb20e7b8",
      "testS3Bucket": "string"
    },
    "azure": {
      "roleId": "32b6e34b3d91647abb20e7b8"
    },
    "gcp": {
      "roleId": "32b6e34b3d91647abb20e7b8"
    }
  },
  "dataProcessRegion": {
    "cloudProvider": "AWS",
    "region": "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"
      }
    ]
  }
}
Ejemplos de respuestas (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",
    "region": "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"
      }
    ]
  }
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}
Ejemplos de respuestas (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"
}