Agregar asignaciones personalizadas de zonas a un clúster global

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

Agregue una o más asignaciones de zona personalizadas al clúster global especificado. Una asignación de zona personalizada asigna un código de ubicación ISO 3166-2 a una zona de su clúster global. De forma predeterminada, MongoDB Cloud asigna cada código de ubicación a la zona geográfica más cercana. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario 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.

    Impresión bonita
aplicación/json

Cuerpo Requerido

Asignación de zona personalizada para agregar al clúster global especificado.

  • customZoneMappings arreglo[objeto] Requerido

    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 es posible, a la etiqueta legible por humanos para la zona personalizada deseada. MongoDB nube asigna el código ISO 3166-1a2 a la zona geográfica más cercana de manera predeterminada. Incluye este parámetro para anular las asignaciones por defecto.

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

    Ocultar los atributos de customZoneMappings Mostrar atributos de customZoneMappings Objeto

    Etiqueta legible por humanos que identifica el subconjunto de un clúster global.

    • ubicación string Requerido

      Código que representa una ubicación que se asigna a una zona de tu clúster global. MongoDB Cloud representa esta ubicación con un código de subdivisión y ubicación ISO 3166-2, cuando sea posible.

    • zona string Requerido

      Etiqueta legible por humanos que identifica la zona en su clúster global. Esta zona se asigna a un código de ubicación.

Respuestas

  • 200 aplicación/json

    Vale

    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 24corresponde a una propiedad Replication Specifications id.

      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 24corresponde a una propiedad Replication Specifications id.

        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 administrará 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.

        Claves de fragmentos con hash
      • isShardKeyUnique booleano

        Indicador que indica si se ha generado un hash de la clave de fragmento personalizada. Si este parámetro false devuelve, este clúster utiliza fragmentación 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

      Valor booleano que controla el modo de gestión bajo el que opera el clúster global. Si este parámetro es verdadero, la fragmentación autogestionada está habilitada y los usuarios controlan la fragmentación de zonas dentro del clúster global. Si este parámetro es falso, la fragmentación gestionada por Atlas está habilitada y Atlas controla la fragmentación de zonas dentro del clúster global.

  • 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.

POST /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping
curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/globalWrites/customZoneMapping' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"customZoneMappings":[{"location":"string","zone":"string"}]}'
Solicitar ejemplos
{
  "customZoneMappings": [
    {
      "location": "string",
      "zone": "string"
    }
  ]
}
Ejemplos de respuestas (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 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"
}