Devolver todas las direcciones IP para un proyecto

Obtener /api/atlas/v2/grupos/{ID de grupo}/direcciones IP

Cuentas de servicio Autorización de resumen

Devuelve todas las direcciones IP de este proyecto. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de solo lectura del proyecto.

Parámetros de ruta

ID de grupo string Requerido

Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".

El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

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.
bonita booleano

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

El valor predeterminado es false.

Impresión bonita

Respuestas

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

Vale
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- ID de grupo string
  
  Cadena de dígitos hexadecimales 24única que identifica el proyecto MongoDB Cloud.
  
  El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.
- Servicios Objeto
  
  Lista de direcciones IP en un proyecto categorizadas por servicios.
  
  Ocultar atributo de servicios Mostrar atributo de servicios Objeto
  
  grupos matriz[objeto]
  
  Direcciones IP de los clusters.
  
  Lista de direcciones IP en un clúster.
  
  Ocultar atributos de clústeres Mostrar atributos de clústeres Objeto
  
  nombre del clúster string
  
  Etiqueta legible por humanos que identifica el clúster.
  
  futuroInbound array[string]
  
  Lista de futuras direcciones IP entrantes asociadas al clúster. Si su red solo permite solicitudes HTTP salientes a direcciones IP específicas, debe permitir el acceso a las siguientes direcciones IP para que su aplicación pueda conectarse al clúster Atlas.
  
  Futuro saliente array[string]
  
  Lista de futuras direcciones IP salientes asociadas al clúster. Si su red solo permite solicitudes HTTP entrantes desde direcciones IP específicas, debe permitir el acceso desde las siguientes direcciones IP para que su clúster Atlas pueda comunicarse con sus webhooks y KMS.
  
  entrante array[string]
  
  Lista de direcciones IP entrantes asociadas al clúster. Si su red solo permite solicitudes HTTP salientes a direcciones IP específicas, debe permitir el acceso a las siguientes direcciones IP para que su aplicación pueda conectarse al clúster Atlas.
  
  saliente array[string]
  
  Lista de direcciones IP salientes asociadas al clúster. Si su red solo permite solicitudes HTTP entrantes desde direcciones IP específicas, debe permitir el acceso desde las siguientes direcciones IP para que su clúster Atlas pueda comunicarse con sus webhooks y KMS.
401 aplicación/json

No autorizado.
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.
403 aplicación/json

Forbidden.
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.
404 aplicación/json

No se encontró.
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.
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/grupos/{groupId}/direccionesip

atlas api projects getGroupIpAddresses --help

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

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true"

Ejemplos de respuestas (200)

{
  "groupId": "32b6e34b3d91647abb20e7b8",
  "services": {
    "clusters": [
      {
        "clusterName": "string",
        "futureInbound": [
          "string"
        ],
        "futureOutbound": [
          "string"
        ],
        "inbound": [
          "string"
        ],
        "outbound": [
          "string"
        ]
      }
    ]
  }
}

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

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

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

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