Retornar todos os endereços IP do plano de controle

OBTER /api/atlas/v2/unauth/controlPlaneIPAddresses

Retorna todos os endereços IP do plano de controle.

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-11-15+json

OK
Ocultar atributos de resposta Mostrar atributos de resposta objeto
- inbound objeto
  
  Lista de endereços IP de entrada para o plano de controle do Atlas , categorizada por provedor de nuvem. Se o seu aplicação permitir solicitações HTTP de saída somente para endereços IP específicos, você deverá permitir o acesso aos seguintes endereços IP para que suas solicitações de API possam alcançar o plano de controle do Atlas .
  
  Ocultar atributos de entrada Mostrar atributos de entrada objeto
  
  AWS objeto
  
  Controle endereços IP do plano na AWS. Cada chave identifica uma região da Amazon Web Services (AWS). Cada valor identifica endereços IP do plano de controle na região da AWS.
  
  Ocultar atributo aws Mostrar atributo aws objeto
  
  * array[string] Propriedades adicionais
  
  Controle endereços IP do plano na AWS. Cada chave identifica uma região da Amazon Web Services (AWS). Cada valor identifica endereços IP do plano de controle na região da AWS.
  
  Azure objeto
  
  Controle endereços IP do plano no Azure. Cada chave identifica uma região do Azure. Cada valor identifica endereços IP do plano de controle na região do Azure.
  
  Ocultar atributo Azure Mostrar atributo Azure objeto
  
  * array[string] Propriedades adicionais
  
  Controle endereços IP do plano no Azure. Cada chave identifica uma região do Azure. Cada valor identifica endereços IP do plano de controle na região do Azure.
  
  GCP objeto
  
  Endereços IP do plano de controle no GCP. Cada chave identifica uma região do Google Cloud (GCP). Cada valor identifica endereços IP do plano de controle na região GCP.
  
  Ocultar atributo gcp Mostrar atributo gcp objeto
  
  * array[string] Propriedades adicionais
  
  Endereços IP do plano de controle no GCP. Cada chave identifica uma região do Google Cloud (GCP). Cada valor identifica endereços IP do plano de controle na região GCP.
- saída objeto
  
  Lista de endereços IP de saída do plano de controle do Atlas , categorizada por provedor de nuvem. Se a sua rede permitir solicitações HTTP de entrada somente de endereços IP específicos, você deverá permitir o acesso dos seguintes endereços IP para que o Atlas possa se comunicar com seus webhooks e KMS.
  
  Ocultar atributos de saída Mostrar atributos de saída objeto
  
  AWS objeto
  
  Controle endereços IP do plano na AWS. Cada chave identifica uma região da Amazon Web Services (AWS). Cada valor identifica endereços IP do plano de controle na região da AWS.
  
  Ocultar atributo aws Mostrar atributo aws objeto
  
  * array[string] Propriedades adicionais
  
  Controle endereços IP do plano na AWS. Cada chave identifica uma região da Amazon Web Services (AWS). Cada valor identifica endereços IP do plano de controle na região da AWS.
  
  Azure objeto
  
  Controle endereços IP do plano no Azure. Cada chave identifica uma região do Azure. Cada valor identifica endereços IP do plano de controle na região do Azure.
  
  Ocultar atributo Azure Mostrar atributo Azure objeto
  
  * array[string] Propriedades adicionais
  
  Controle endereços IP do plano no Azure. Cada chave identifica uma região do Azure. Cada valor identifica endereços IP do plano de controle na região do Azure.
  
  GCP objeto
  
  Endereços IP do plano de controle no GCP. Cada chave identifica uma região do Google Cloud (GCP). Cada valor identifica endereços IP do plano de controle na região GCP.
  
  Ocultar atributo gcp Mostrar atributo gcp objeto
  
  * array[string] Propriedades adicionais
  
  Endereços IP do plano de controle no GCP. Cada chave identifica uma região do Google Cloud (GCP). Cada valor identifica endereços IP do plano de controle na região GCP.
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/unauth/controlPlaneIPAddresses

atlas api root listControlPlaneIpAddresses --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/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.ListControlPlaneIpAddressesApiParams{}
	sdkResp, httpResp, err := client.RootApi.
		ListControlPlaneIpAddressesWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true"

Exemplos de resposta (200)

{
  "inbound": {
    "aws": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "azure": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "gcp": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    }
  },
  "outbound": {
    "aws": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "azure": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    },
    "gcp": {
      "additionalProperty1": [
        "string"
      ],
      "additionalProperty2": [
        "string"
      ]
    }
  }
}

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