Retornar um serviço de endpoint privado para um fornecedor

OBTER /api/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}

Retorna o nome, as interfaces e o estado do serviço de ponto de extremidade privado especificado de um projeto. O provedor de serviços de nuvem hospedou esse serviço de ponto de extremidade privado que pertence ao projeto. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função somente leitura do projeto.

parâmetros de caminho

groupId string Obrigatório

Sequência única 24de dí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})$.
cloudProvider string Obrigatório

Provedor de serviços de nuvem que gerencia esse serviço de ponto de extremidade privado.

Os valores são AWS, AZURE ou GCP. O valor padrão é AWS.
endpointServiceId string Obrigatório

string exclusiva de 24 dígitos hexadecimais que identifica o serviço de ponto de extremidade privado que você deseja retornar.

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

Respostas

200 aplicação/json

OK
Um dos seguintes:
objeto AWS objeto AZURE objeto GCP
Grupo de configurações do Private Endpoint Service.

Ocultar atributos Mostrar atributos

cloudProvider string Obrigatório Discriminador

Fornecedor de serviços de nuvem que atende ao serviço de endpoint solicitado.

O valor é AWS.

Mensagem de erro string

Mensagem de erro retornada ao solicitar recurso de conexão privada. O recurso retornará null se a solicitação for bem-sucedida.

id string

String única de 24dígitos hexadecimais que identifica o serviço de endpoints privados.

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

regionName string

Região do provedor de nuvem que gerencia esse serviço de endpoint privado.

Status string

Estado da conexão do Private Endpoint Service quando o MongoDB Cloud recebeu esta solicitação.

Os valores são INITIATING, AVAILABLE, WAITING_FOR_USER, FAILED ou DELETING.

endpointServiceName string

String exclusiva que identifica o serviço de endpoints do Amazon Web Services (AWS) PrivateLink. O MongoDB Cloud retorna nulo enquanto cria o serviço endpoint.

O formato deve corresponder ao seguinte padrão: ^com\.amazonaws\.vpce\.[a-z-0-9]+\.vpce-svc-[0-9a-f]{17}.

interfaceEndpoints array[string]

Lista de strings que identificam interfaces de endpoint privadas aplicadas ao projeto especificado.

O formato de cada um deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.
Grupo de configurações do Private Endpoint Service.

Ocultar atributos Mostrar atributos

cloudProvider string Obrigatório Discriminador

Fornecedor de serviços de nuvem que atende ao serviço de endpoint solicitado.

O valor é AZURE.

Mensagem de erro string

Mensagem de erro retornada ao solicitar recurso de conexão privada. O recurso retornará null se a solicitação for bem-sucedida.

id string

String única de 24dígitos hexadecimais que identifica o serviço de endpoints privados.

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

regionName string

Região do provedor de nuvem que gerencia esse serviço de endpoint privado.

Status string

Estado da conexão do Private Endpoint Service quando o MongoDB Cloud recebeu esta solicitação.

Os valores são INITIATING, AVAILABLE, WAITING_FOR_USER, FAILED ou DELETING.

privateEndpoints array[string]

Lista de endpoints privados atribuídos a este serviço de link privado do Azure.

O formato de cada um deve corresponder ao seguinte padrão: ^\/subscriptions\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/resource[gG]roups\/([-\w._()]+)\/providers\/Microsoft\.Network\/privateEndpoints\/([-\w._()]+).

privateLinkServiceName string

String exclusiva que identifica o serviço de link privado do Azure que o MongoDB Cloud gerencia.

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

privateLinkServiceResourceId string

Caminho relativo à raiz que se identifica pelo Serviço de Link Privado do Azure que o MongoDB Cloud gerencia. Use esse valor para criar uma conexão de endpoint privada para uma VNet do Azure.
Grupo de configurações do Private Endpoint Service.

Ocultar atributos Mostrar atributos

cloudProvider string Obrigatório Discriminador

Fornecedor de serviços de nuvem que atende ao serviço de endpoint solicitado.

O valor é GCP.

Mensagem de erro string

Mensagem de erro retornada ao solicitar recurso de conexão privada. O recurso retornará null se a solicitação for bem-sucedida.

id string

String única de 24dígitos hexadecimais que identifica o serviço de endpoints privados.

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

regionName string

Região do provedor de nuvem que gerencia esse serviço de endpoint privado.

Status string

Estado da conexão do Private Endpoint Service quando o MongoDB Cloud recebeu esta solicitação.

Os valores são INITIATING, AVAILABLE, WAITING_FOR_USER, FAILED ou DELETING.

endpointGroupNames array[string]

Lista de grupos de endpoints de rede do Google Cloud que correspondem ao serviço endpoint Private Service Connect.

serviceAttachmentNames array[string]

Lista de localizadores uniformes de recursos (URLs) que identificam endpoints que o MongoDB Cloud pode usar para acessar um Google Cloud Service em uma rede Virtual Private Connection (VPC) do Google Cloud.

O formato de cada um deve corresponder ao seguinte padrão: https:\/\/([a-z0-9\.]+)+\.[a-z]{2,}(\/[a-z0-9\-]+)+\/projects\/p-[a-z0-9]+\/regions\/[a-z\-0-9]+\/serviceAttachments\/[a-z0-9\-]+.
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.

GET /API/atlas/v1.0/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Exemplos de resposta (200)

{
  "cloudProvider": "AWS",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "endpointServiceName": "string",
  "interfaceEndpoints": [
    "32b6e34b3d91647abb20e7b8"
  ]
}

{
  "cloudProvider": "AZURE",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "privateEndpoints": [
    "string"
  ],
  "privateLinkServiceName": "string",
  "privateLinkServiceResourceId": "/subscriptions/ae349d51-d12b-ee3d-2a27-7d53f6479cf0/resourcegroups/KObGGz/providers/Microsoft.Network/privateLinkServices/pls_d1820713f8153388d533e9de"
}

{
  "cloudProvider": "GCP",
  "errorMessage": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "regionName": "string",
  "status": "INITIATING",
  "endpointGroupNames": [
    "string"
  ],
  "serviceAttachmentNames": [
    "string"
  ]
}

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