Criar uma conexão de peering de rede

POSTAR /api/atlas/v1.0/groups/{groupId}/peers

Cria uma nova conexão de emparelhamento de rede no projeto especificado. O emparelhamento de rede permite que vários aplicativos hospedados na nuvem se conectem com segurança ao mesmo projeto. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto. Para saber mais sobre considerações e pré-requisitos, consulte a Documentação de emparelhamento de rede.

Pré-requisitos de emparelhamento de rede Azure

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

aplicação/json

corpo, corpo objeto Obrigatório

Crie uma conexão de peering de rede.

Grupo de configurações de conexão de emparelhamento de rede.

containerId string Obrigatório

String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que contém a conexão de emparelhamento de rede especificada.

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

Fornecedor de serviços de nuvem que atende à conexão de peering de rede solicitada.

O valor é AWS.
accepterRegionName string Obrigatório

Região do Amazon Web Services (AWS) onde fica a conexão de emparelhamento virtual (VPC) que você emparelhou com a VPC do MongoDB Cloud. O recurso retorna null se sua VPC e a VPC do MongoDB Cloud estiverem na mesma região.
awsAccountId string Obrigatório

String exclusiva de 12 dígitos que identifica a conta da Amazon Web Services (AWS) que possui a VPC que você emparelhou com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^[0-9]{12}$.
routeTableCidrBlock string Obrigatório

Endereços IP (Internet Protocol) expressos em notação CIDR (Classless Inter-Domain Routing) da sub-rede da VPC que você deseja emparelhar com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.
vpcId string Obrigatório

String única que identifica a VPC na Amazon Web Services (AWS) que você deseja emparelhar com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^vpc-[0-9a-f]{17}$.

Grupo de configurações de conexão de emparelhamento de rede.

containerId string Obrigatório

String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que contém a conexão de emparelhamento de rede especificada.

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

Fornecedor de serviços de nuvem que atende à conexão de peering de rede solicitada.

O valor é AZURE.
ID do Diretório Azure string(uuid) Obrigatório

String exclusiva que identifica o diretório do Azure AD em que a VNet emparelhada com a VNet do MongoDB Cloud está localizada.
ID de Assinatura do Azure string(uuid) Obrigatório

String exclusiva que identifica a assinatura do Azure na qual a VNet que você fez Peering com a VNet do MongoDB Cloud está localizada.
Nome do Grupo de Recursos string Obrigatório

Etiqueta legível por humanos que identifica o grupo de recursos no qual a VNet para emparelhamento com a VNet do MongoDB Cloud está localizada.

O formato deve corresponder ao seguinte padrão: ^([-\w._()])+$.
vnetName string Obrigatório

Etiqueta legível por humanos que identifica a VNet que você deseja emparelhar com a VNet do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^([-\w._()])$.

Grupo de configurações de conexão de emparelhamento de rede.

containerId string Obrigatório

String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que contém a conexão de emparelhamento de rede especificada.

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

Fornecedor de serviços de nuvem que atende à conexão de peering de rede solicitada.

O valor é GCP.
gcpProjectId string Obrigatório

Etiqueta legível por humanos que identifica o projeto GCP que contém a rede que você deseja emparelhar com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}.
networkName string Obrigatório

Etiqueta legível por humanos que identifica a rede a ser emparelhada com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: [a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?.

Respostas

200 aplicação/json

OK
Um dos seguintes:
objeto AWS objeto AZURE objeto GCP
Grupo de configurações de conexão de emparelhamento de rede.

Ocultar atributos Mostrar atributos

containerId string Obrigatório

String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que contém a conexão de emparelhamento de rede especificada.

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

id string

String única de 24dígitos hexadecimais que identifica a conexão de peering de rede.

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

providerName string Discriminador

Fornecedor de serviços de nuvem que atende à conexão de peering de rede solicitada.

O valor é AWS.

accepterRegionName string Obrigatório

Região do Amazon Web Services (AWS) onde fica a conexão de emparelhamento virtual (VPC) que você emparelhou com a VPC do MongoDB Cloud. O recurso retorna null se sua VPC e a VPC do MongoDB Cloud estiverem na mesma região.

awsAccountId string Obrigatório

String exclusiva de 12 dígitos que identifica a conta da Amazon Web Services (AWS) que possui a VPC que você emparelhou com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^[0-9]{12}$.

ID de conexão string

String exclusiva que identifica a conexão de emparelhamento na AWS.

errorStateName string

Tipo de erro que pode ser retornado ao solicitar uma conexão de emparelhamento do Amazon Web Services (AWS). O recurso retornará null se a solicitação for bem-sucedida.

Os valores são REJECTED, EXPIRED ou INVALID_ARGUMENT.

routeTableCidrBlock string Obrigatório

Endereços IP (Internet Protocol) expressos em notação CIDR (Classless Inter-Domain Routing) da sub-rede da VPC que você deseja emparelhar com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$.

statusName string

Estado da conexão de peering de rede no momento em que você fez a solicitação.

Os valores são INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE ou TERMINATING.

vpcId string Obrigatório

String única que identifica a VPC na Amazon Web Services (AWS) que você deseja emparelhar com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^vpc-[0-9a-f]{17}$.
Grupo de configurações de conexão de emparelhamento de rede.

Ocultar atributos Mostrar atributos

containerId string Obrigatório

String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que contém a conexão de emparelhamento de rede especificada.

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

id string

String única de 24dígitos hexadecimais que identifica a conexão de peering de rede.

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

providerName string Discriminador

Fornecedor de serviços de nuvem que atende à conexão de peering de rede solicitada.

O valor é AZURE.

ID do Diretório Azure string(uuid) Obrigatório

String exclusiva que identifica o diretório do Azure AD em que a VNet emparelhada com a VNet do MongoDB Cloud está localizada.

ID de Assinatura do Azure string(uuid) Obrigatório

String exclusiva que identifica a assinatura do Azure na qual a VNet que você fez Peering com a VNet do MongoDB Cloud está localizada.

estado de erro string

Mensagem de erro retornada quando um recurso de emparelhamento de rede Azure solicitado retorna "status" : "FAILED". O recurso retornará null se a solicitação for bem-sucedida.

Nome do Grupo de Recursos string Obrigatório

Etiqueta legível por humanos que identifica o grupo de recursos no qual a VNet para emparelhamento com a VNet do MongoDB Cloud está localizada.

O formato deve corresponder ao seguinte padrão: ^([-\w._()])+$.

Status string

Estado da conexão de peering de rede no momento em que você fez a solicitação.

Os valores são ADDING_PEER, AVAILABLE, FAILED, DELETION_FAILED ou DELETING.

vnetName string Obrigatório

Etiqueta legível por humanos que identifica a VNet que você deseja emparelhar com a VNet do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^([-\w._()])$.
Grupo de configurações de conexão de emparelhamento de rede.

Ocultar atributos Mostrar atributos

containerId string Obrigatório

String exclusiva de 24 dígitos hexadecimais que identifica o contêiner de rede do MongoDB Cloud que contém a conexão de emparelhamento de rede especificada.

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

id string

String única de 24dígitos hexadecimais que identifica a conexão de peering de rede.

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

providerName string Discriminador

Fornecedor de serviços de nuvem que atende à conexão de peering de rede solicitada.

O valor é GCP.

Mensagem de erro string

Detalhes do erro retornados ao solicitar um recurso de emparelhamento de rede GCP. O recurso retornará null se a solicitação for bem-sucedida.

gcpProjectId string Obrigatório

Etiqueta legível por humanos que identifica o projeto GCP que contém a rede que você deseja emparelhar com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: ^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}.

networkName string Obrigatório

Etiqueta legível por humanos que identifica a rede a ser emparelhada com a VPC do MongoDB Cloud.

O formato deve corresponder ao seguinte padrão: [a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?.

Status string

Estado da conexão de peering de rede no momento em que você fez a solicitação.

Os valores são ADDING_PEER, WAITING_FOR_USER, AVAILABLE, FAILED ou DELETING.
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.
409 aplicação/json

Conflito.
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}/peers

curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/peers' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"containerId":"32b6e34b3d91647abb20e7b8","providerName":"AWS","accepterRegionName":"string","awsAccountId":"string","routeTableCidrBlock":"string","vpcId":"string"}'

Exemplos de solicitação

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "accepterRegionName": "string",
  "awsAccountId": "string",
  "routeTableCidrBlock": "string",
  "vpcId": "string"
}

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "providerName": "AZURE",
  "azureDirectoryId": "string",
  "azureSubscriptionId": "string",
  "resourceGroupName": "string",
  "vnetName": "string"
}

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "providerName": "GCP",
  "gcpProjectId": "string",
  "networkName": "string"
}

Exemplos de resposta (200)

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AWS",
  "accepterRegionName": "string",
  "awsAccountId": "string",
  "connectionId": "string",
  "errorStateName": "REJECTED",
  "routeTableCidrBlock": "string",
  "statusName": "INITIATING",
  "vpcId": "string"
}

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "AZURE",
  "azureDirectoryId": "string",
  "azureSubscriptionId": "string",
  "errorState": "string",
  "resourceGroupName": "string",
  "status": "ADDING_PEER",
  "vnetName": "string"
}

{
  "containerId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "providerName": "GCP",
  "errorMessage": "string",
  "gcpProjectId": "string",
  "networkName": "string",
  "status": "ADDING_PEER"
}

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 (409)

{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}

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"
}