Retornar uma conexão PrivateLink

OBTER /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}

Retorna os detalhes de uma conexão do link privado dentro do 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 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})$.

  • ID de conexão string Obrigatório

    ID exclusivo que identifica a conexão do link privado.

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.

Respostas

  • 200 application/vnd.atlas.2023-02-01+json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • _id string

      O ID da conexão do link privado.

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

    • ARN string

      Nome do recurso da Amazon (ARN). Necessário para o provedor AWS e o fornecedor MSK.

      O formato deve corresponder ao seguinte padrão: ^arn:aws:kafka.

    • azureResourceIds array[string]

      IDs de recursos do Azure de cada zona de disponibilidade para o cluster Confluent do Azure.

    • dnsDomain string

      O nome de host do domínio. Necessário para as seguintes combinações de provedor e fornecedor:

      • Provedor AWS com fornecedor Confluent.
      • Provedor AZURE com fornecedor EVENTHUB ou CONFLUENT.
    • dnsSubDomain array[string]

      Nome do subdomínio do cluster da Confluent. Normalmente, essas são suas zonas de disponibilidade. Necessário para o provedor AWS e o fornecedor CONFLUENT; se o cluster AWS CONFLUENT não usar subdomínios, você deverá definir esse campo como a array vazia [].

    • Mensagem de erro string

      Mensagem de erro se o estado for FALHA.

    • interfaceEndpointId string

      ID do ponto de extremidade da interface criado a partir do ID do ponto de extremidade de serviço fornecido.

    • interfaceEndpointName string

      Nome do ponto de conexão da interface criado a partir do ID do ponto de conexão de serviço fornecido.

    • fornecedor string Obrigatório

      Provedor em que o cluster Kafka está implantado. Os valores válidos são AWS e Azure.

    • providerAccountId string

      ID da conta do provedor de nuvem.

    • região string

      A região do cluster do provedor. Consulte as regiões compatíveis com Azure e AWS.

    • serviceEndpointId string

      Para o AZURE EVENTHUB, esta é a ID do namespace do ponto de extremidade. Para o cluster AWS CONFLUENT, este é o nome do serviço VPC do ponto de extremidade.

    • state string

      Estado em que a conexão está.

    • vendor string

      Fornecedor que gerencia o serviço de nuvem. A seguir estão os valores dos fornecedores por provedor:

      • Amazon Web Services -- MSK para clusters do Amazon Web Services MSK Kafka -- CONFLUENT para clusters do Confluent Kafka no Amazon Web Services -- Kinesis para Amazon Web Services Kinesis Data Streams (em breve).

      • Azure -- EVENTHub para Azure EventHub. -- CONFLUENT para os clusters Confluent Kafka no Azure

      OBSERVAÇÃO A omissão do campo do fornecedor padronizará para usar o fornecedor GENérico.

  • 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/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}
atlas api streams getGroupStreamPrivateLinkConnection --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231115001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetGroupStreamPrivateLinkConnectionApiParams{}
	sdkResp, httpResp, err := client.StreamsApi.
		GetGroupStreamPrivateLinkConnectionWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true"
Exemplos de resposta (200)
{
  "_id": "32b6e34b3d91647abb20e7b8",
  "arn": "string",
  "azureResourceIds": [
    "string"
  ],
  "dnsDomain": "string",
  "dnsSubDomain": [
    "string"
  ],
  "errorMessage": "string",
  "interfaceEndpointId": "string",
  "interfaceEndpointName": "string",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "provider": "string",
  "providerAccountId": "string",
  "region": "string",
  "serviceEndpointId": "string",
  "state": "string",
  "vendor": "string"
}
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"
}