Adicionar mapeamentos de zona personalizados a um cluster global

POSTAR /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping

Adicione um ou mais mapeamentos de zona personalizados ao cluster global especificado. Um mapeamento de zona personalizado corresponde a um código de localização ISO 3166-2 para uma zona em seu cluster global. Por padrão, o MongoDB Cloud mapeia cada código de localização para a zona geográfica mais próxima.

Requisitos de função
  • Proprietário do projeto
Global Clusters

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

  • clusterName string Obrigatório

    Etiqueta legível para humanos que identifica este cluster.

    O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

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
aplicação/json

corpo, corpo Obrigatório

Mapeamento de zona personalizado para adicionar ao cluster global especificado.

  • customZoneMappings array[objeto] Obrigatório

    Lista que contém pares de valores-chave separados por vírgula para mapear zonas de regiões geográficas. Esses pares mapeiam um código de localização ISO 3166-1a2, com um código de subdivisão ISO 3166-2 quando possível, para a etiqueta legível para humanos para a zona personalizada desejada. O MongoDB Cloud mapeia o código ISO 3166-1a2 para a zona geográfica mais próxima por padrão. Inclua este parâmetro para substituir mapeamentos padrão.

    Este parâmetro retorna um objeto vazio se não existirem zonas personalizadas.

    Ocultar atributos customZoneMappings Mostrar atributos de customZoneMappings objeto

    Rótulo legível por humanos que identifica o subconjunto de um cluster global.

    • localização string Obrigatório

      Código que representa um local mapeado para uma zona em seu cluster global. O MongoDB Cloud representa este local com um local ISO 3166-2 códigos de localização e subdivisão quando possível.

    • zona string Obrigatório

      Rótulo legível por humanos que identifica a zona em seu cluster global. Esta zona mapeia para um código de localização.

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • customZoneMapping objeto

      Lista que contém pares de valores-chave separados por vírgula para mapear zonas de regiões geográficas. Esses pares mapeiam um código de localização ISO 3166-1a2, com um código de subdivisão ISO 3166-2 quando possível, para uma string 24-hexadecimal exclusiva que identifica a zona personalizada.

      A string hexadecimal 24corresponde a uma propriedade Replication Specifications id.

      Este parâmetro retorna um objeto vazio se não existirem zonas personalizadas.

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

      Ocultar atributo customZoneMapping Mostrar atributo customZoneMapping objeto
      • * string Propriedades adicionais

        Lista que contém pares de valores-chave separados por vírgula para mapear zonas de regiões geográficas. Esses pares mapeiam um código de localização ISO 3166-1a2, com um código de subdivisão ISO 3166-2 quando possível, para uma string 24-hexadecimal exclusiva que identifica a zona personalizada.

        A string hexadecimal 24corresponde a uma propriedade Replication Specifications id.

        Este parâmetro retorna um objeto vazio se não existirem zonas personalizadas.

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

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

    • managedNamespaces array[objeto]

      Lista que contém um namespace para um cluster global. O MongoDB Cloud gerencia este cluster.

      Ocultar atributos managedNamespaces Mostrar atributos managedNamespaces objeto
      • collection string Obrigatório

        Rótulo legível por humanos da coleção a ser gerenciada para esse cluster global.

      • customShardKey string Obrigatório

        Parâmetro do banco de dados utilizado para dividir a coleção em fragmentos. Clusters globais exigem uma chave de shard composta. Essa chave de shard composta combina o parâmetro de localização e a chave personalizada selecionada pelo usuário.

      • db string Obrigatório

        Etiqueta legível para humanos do banco de dados a ser gerenciado para este cluster global.

      • isCustomShardKeyHashed booleano

        Sinalizador que indica se alguém fez hash da chave de shard personalizada para a collection especificada. Se você definir esse valor como false, o MongoDB cloud usará fragmentação à distância.

        O valor padrão é false.

        Hashed shard keys
      • isShardKeyUnique booleano

        Sinalizador que indica se alguém fez hash da chave de shard personalizada. Se esse parâmetro false retornar, esse cluster usará fragmentação à distância.

        O valor padrão é false.

      • numInitialChunks integer(int64)

        Número mínimo de chunks a serem criados inicialmente ao fragmentar uma coleção vazia com uma chave de fragmento com hash .

        O valor máximo é 8192.

        Fragmentação de cluster global
      • presplitHashedZones booleano

        Sinalizador que indica se o MongoDB Cloud deve criar e distribuir chunks iniciais para uma collection vazia ou inexistente. O MongoDB Cloud distribui dados com base nas zonas e faixas de zonas definidos para a collection.

        O valor padrão é false.

        Chave de fragmento com hash
    • selfManagedSharding booleano

      Booleano que controla em qual modo de gerenciamento o cluster global está operando. Se este parâmetro for verdadeiro, a fragmentação autogerenciada estará habilitada e os usuários estiverem no controle da fragmentação da zona dentro do cluster global. Se este parâmetro for falso, a fragmentação gerenciada pelo Atlas estará habilitada e o Atlas controlará a fragmentação da zona dentro do cluster global.

  • 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/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"}]}'
Exemplos de solicitação
{
  "customZoneMappings": [
    {
      "location": "string",
      "zone": "string"
    }
  ]
}
Exemplos de resposta (200)
{
  "customZoneMapping": {
    "additionalProperty1": "32b6e34b3d91647abb20e7b8",
    "additionalProperty2": "32b6e34b3d91647abb20e7b8"
  },
  "managedNamespaces": [
    {
      "collection": "string",
      "customShardKey": "string",
      "db": "string",
      "isCustomShardKeyHashed": false,
      "isShardKeyUnique": false,
      "numInitialChunks": 42,
      "presplitHashedZones": false
    }
  ],
  "selfManagedSharding": true
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}