Devolver todas las direcciones IP del plano de control

Obtener /api/atlas/v2/unauth/direccionesIP del plano de control

Devuelve todas las direcciones IP del plano de control.

Parámetros de consulta

envolvente booleano

Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

El valor predeterminado es false.

Respuestas

200 application/vnd.atlas.2023-11-15+json

Vale
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- entrante Objeto
  
  Lista de direcciones IP entrantes al plano de control de Atlas, categorizadas por proveedor de nube. Si su aplicación solo permite solicitudes HTTP salientes a direcciones IP específicas, debe permitir el acceso a las siguientes direcciones IP para que sus solicitudes de API puedan llegar al plano de control de Atlas.
  
  Ocultar atributos entrantes Mostrar atributos de entrada Objeto
  
  AWS Objeto
  
  Direcciones IP del plano de control en AWS. Cada clave identifica una región de Amazon Web Services (AWS). Cada valor identifica las direcciones IP del plano de control en la región de AWS.
  
  Ocultar atributo aws Mostrar atributo aws Objeto
  
  * array[string] Propiedades adicionales
  
  Direcciones IP del plano de control en AWS. Cada clave identifica una región de Amazon Web Services (AWS). Cada valor identifica las direcciones IP del plano de control en la región de AWS.
  
  azur Objeto
  
  Direcciones IP del plano de control en Azure. Cada clave identifica una región de Azure. Cada valor identifica las direcciones IP del plano de control en la región de Azure.
  
  Ocultar atributo azul Mostrar atributo azul Objeto
  
  * array[string] Propiedades adicionales
  
  Direcciones IP del plano de control en Azure. Cada clave identifica una región de Azure. Cada valor identifica las direcciones IP del plano de control en la región de Azure.
  
  gcp Objeto
  
  Direcciones IP del plano de control en GCP. Cada clave identifica una región de Google Cloud (GCP). Cada valor identifica las direcciones IP del plano de control en la región de GCP.
  
  Ocultar atributo gcp Mostrar atributo gcp Objeto
  
  * array[string] Propiedades adicionales
  
  Direcciones IP del plano de control en GCP. Cada clave identifica una región de Google Cloud (GCP). Cada valor identifica las direcciones IP del plano de control en la región de GCP.
- saliente Objeto
  
  Lista de direcciones IP salientes del plano de control de Atlas, categorizadas por proveedor de nube. Si su red solo permite solicitudes HTTP entrantes desde direcciones IP específicas, debe permitir el acceso desde las siguientes direcciones IP para que Atlas pueda comunicarse con sus webhooks y KMS.
  
  Ocultar atributos de salida Mostrar atributos de salida Objeto
  
  AWS Objeto
  
  Direcciones IP del plano de control en AWS. Cada clave identifica una región de Amazon Web Services (AWS). Cada valor identifica las direcciones IP del plano de control en la región de AWS.
  
  Ocultar atributo aws Mostrar atributo aws Objeto
  
  * array[string] Propiedades adicionales
  
  Direcciones IP del plano de control en AWS. Cada clave identifica una región de Amazon Web Services (AWS). Cada valor identifica las direcciones IP del plano de control en la región de AWS.
  
  azur Objeto
  
  Direcciones IP del plano de control en Azure. Cada clave identifica una región de Azure. Cada valor identifica las direcciones IP del plano de control en la región de Azure.
  
  Ocultar atributo azul Mostrar atributo azul Objeto
  
  * array[string] Propiedades adicionales
  
  Direcciones IP del plano de control en Azure. Cada clave identifica una región de Azure. Cada valor identifica las direcciones IP del plano de control en la región de Azure.
  
  gcp Objeto
  
  Direcciones IP del plano de control en GCP. Cada clave identifica una región de Google Cloud (GCP). Cada valor identifica las direcciones IP del plano de control en la región de GCP.
  
  Ocultar atributo gcp Mostrar atributo gcp Objeto
  
  * array[string] Propiedades adicionales
  
  Direcciones IP del plano de control en GCP. Cada clave identifica una región de Google Cloud (GCP). Cada valor identifica las direcciones IP del plano de control en la región de GCP.
500 aplicación/json

Error Interno del Servidor.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- badRequestDetail Objeto
  
  Detalle de solicitud incorrecto.
  
  Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
  
  campos matriz[objeto]
  
  Describe todas las violaciones en una solicitud de cliente.
  
  Ocultar atributos de campos Mostrar atributos de campos Objeto
  
  Descripción string Requerido
  
  Una descripción de por qué el elemento de solicitud es incorrecto.
  
  Campo string Requerido
  
  Una ruta que conduce a un campo en el cuerpo de la solicitud.
- detalle string
  
  Describe las condiciones o razones específicas que causan cada tipo de error.
- Error integer(int32) Requerido
  
  Código de estado HTTP devuelto con este error.
  
  Documentación externa
- errorCode string Requerido
  
  Código de error de aplicación devuelto con este error.
- Parámetros matriz[objeto]
  
  Parámetros utilizados para dar más información sobre el error.
- razón string
  
  Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/unauth/controlPlaneIPAddresses

atlas api root listControlPlaneAddresses --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.ListControlPlaneIpAddressesApiParams{}
	sdkResp, httpResp, err := client.RootApi.
		ListControlPlaneIpAddressesWithParams(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/unauth/controlPlaneIPAddresses?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/unauth/controlPlaneIPAddresses?pretty=true"

Ejemplos de respuestas (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"
      ]
    }
  }
}

Ejemplos de respuestas (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"
}