Crear un Namespace Gestionado en un Clúster Global

publicación /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces

Crea un namespace gestionado dentro del clúster global especificado. Un namespace gestionado identifica una colección utilizando el nombre de la base de datos, el separador de puntos y el nombre de la colección.

Requisitos del rol
  • Administrador de acceso a los datos del proyecto
Clústeres globales

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})$.

  • Nombre del clúster string Requerido

    Etiqueta legible por humanos que identifica este clúster.

    El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

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.

    pretty-print
application/json

Cuerpo Requerido

Namespace gestionado para crear dentro del clúster global especificado.

  • Colección string Requerido

    Etiqueta legible por humanos para la colección que se gestionará en este clúster global.

  • customShardKey string Requerido

    Parámetro de base de datos utilizado para dividir la colección en particiones. Los clústeres globales requieren una clave de partición compuesta. Esta clave de partición compuesta combina el parámetro de ubicación y la clave personalizada seleccionada por el usuario.

  • db string Requerido

    Etiqueta legible por humanos de la base de datos que se va a gestionar para este clúster global.

  • isCustomShardKeyHashed booleano

    Indicador que señala si alguien ha encriptada la clave de partición personalizada para la colección especificada. Si estableces este valor en false, MongoDB nube utiliza particionado clasificado por rango.

    El valor por defecto es false.

    clave de partición con hash
  • isShardKeyUnique booleano

    Indicador que muestra si alguien encriptada la clave de partición personalizada. Si este parámetro devuelve false, este clúster utiliza la particionado clasificado por rango.

    El valor por defecto es false.

  • numInitialChunks integer(int64)

    Número mínimo de fragmentos a crear inicialmente al particionar una colección vacía con una clave de partición con hash.

    El valor máximo es 8192.

    Particionado de clúster global
  • presplitHashedZones booleano

    Indicador que señala si MongoDB Cloud debe crear y distribuir fragmentos iniciales para una colección vacía o que no existe. MongoDB nube distribuye datos según las zonas definidas y los rangos de zonas para la colección.

    El valor por defecto es false.

    clave de partición con hash

Respuestas

  • 200 application/json

    OK

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

      Lista que contiene pares clave-valor separados por comas para mapear zonas a regiones geográficas. Estos pares asignan un código de ubicación ISO 3166-1a2, con un código de subdivisión ISO 3166-2 cuando sea posible, a una cadena hexadecimal única de 24que identifica la zona personalizada.

      La cadena hexadecimal de 24corresponde a una propiedad de id Replication Specifications.

      Este parámetro devuelve un objeto vacío si no existen zonas personalizadas.

      Ejemplo: {"US-VA": "6716c5a804f4ce77e899bf99", "DE": "6716c5a804f4ce77e899bf9a"}.

      Ocultar atributo customZoneMapping Mostrar el atributo customZoneMapping Objeto
      • * string Propiedades adicionales

        Lista que contiene pares clave-valor separados por comas para mapear zonas a regiones geográficas. Estos pares asignan un código de ubicación ISO 3166-1a2, con un código de subdivisión ISO 3166-2 cuando sea posible, a una cadena hexadecimal única de 24que identifica la zona personalizada.

        La cadena hexadecimal de 24corresponde a una propiedad de id Replication Specifications.

        Este parámetro devuelve un objeto vacío si no existen zonas personalizadas.

        Ejemplo: {"US-VA": "6716c5a804f4ce77e899bf99", "DE": "6716c5a804f4ce77e899bf9a"}.

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

    • managedNamespaces arreglo[objeto]

      Lista que contiene un namespace para un clúster global. MongoDB nube gestiona este clúster.

      Ocultar atributos de managedNamespaces Mostrar atributos de managedNamespaces Objeto
      • Colección string Requerido

        Etiqueta legible por humanos para la colección que se gestionará en este clúster global.

      • customShardKey string Requerido

        Parámetro de base de datos utilizado para dividir la colección en particiones. Los clústeres globales requieren una clave de partición compuesta. Esta clave de partición compuesta combina el parámetro de ubicación y la clave personalizada seleccionada por el usuario.

      • db string Requerido

        Etiqueta legible por humanos de la base de datos que se va a gestionar para este clúster global.

      • isCustomShardKeyHashed booleano

        Indicador que señala si alguien ha encriptada la clave de partición personalizada para la colección especificada. Si estableces este valor en false, MongoDB nube utiliza particionado clasificado por rango.

        El valor por defecto es false.

        clave de partición con hash
      • isShardKeyUnique booleano

        Indicador que muestra si alguien encriptada la clave de partición personalizada. Si este parámetro devuelve false, este clúster utiliza la particionado clasificado por rango.

        El valor por defecto es false.

      • numInitialChunks integer(int64)

        Número mínimo de fragmentos a crear inicialmente al particionar una colección vacía con una clave de partición con hash.

        El valor máximo es 8192.

        Particionado de clúster global
      • presplitHashedZones booleano

        Indicador que señala si MongoDB Cloud debe crear y distribuir fragmentos iniciales para una colección vacía o que no existe. MongoDB nube distribuye datos según las zonas definidas y los rangos de zonas para la colección.

        El valor por defecto es false.

        clave de partición con hash
    • Segmentación autogestionada booleano

      Booleano que controla en qué modo de gestión opera el clúster global. Si este parámetro es verdadero, el Particionado Autogestionado está habilitado y los usuarios tienen el control del particionado de zonas dentro del Clúster Global. Si este parámetro es falso, se habilita el Atlas-Managed Sharding y Atlas controla el particionado por zonas dentro del Clúster global.

  • 400 application/json

    Solicitud incorrecta.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    No se ha encontrado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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.

  • 405 application/json

    Método no permitido.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Error interno del servidor.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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.

POST /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces
curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/globalWrites/managedNamespaces' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"collection":"string","customShardKey":"string","db":"string","isCustomShardKeyHashed":false,"isShardKeyUnique":false,"numInitialChunks":42,"presplitHashedZones":false}'
Solicitar ejemplos
{
  "collection": "string",
  "customShardKey": "string",
  "db": "string",
  "isCustomShardKeyHashed": false,
  "isShardKeyUnique": false,
  "numInitialChunks": 42,
  "presplitHashedZones": false
}
Ejemplos de respuesta (200)
{
  "customZoneMapping": {
    "additionalProperty1": "32b6e34b3d91647abb20e7b8",
    "additionalProperty2": "32b6e34b3d91647abb20e7b8"
  },
  "managedNamespaces": [
    {
      "collection": "string",
      "customShardKey": "string",
      "db": "string",
      "isCustomShardKeyHashed": false,
      "isShardKeyUnique": false,
      "numInitialChunks": 42,
      "presplitHashedZones": false
    }
  ],
  "selfManagedSharding": true
}
Ejemplos de respuesta (400)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "error": 400,
  "errorCode": "VALIDATION_ERROR",
  "reason": "Bad Request"
}
Ejemplos de respuesta (401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Ejemplos de respuesta (403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Ejemplos de respuesta (404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Ejemplos de respuesta (405)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 405,
  "errorCode": "ATLAS_BACKUP_CANCEL_SHARD_RESTORE_JOB_NOT_ALLOWED",
  "reason": "Method Not Allowed"
}
Ejemplos de respuesta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}