Cree un espacio de trabajo de transmisión con conexiones de muestra

PUBLICAR /api/atlas/v2/groups/{groupId}/streams:withSampleConnections
Cuentas de servicio Autorización de resumen

Crea un espacio de trabajo de flujo en el proyecto especificado con conexiones de muestra. Para usar este recurso, la cuenta de servicio o clave API solicitante debe tener el rol de administrador de acceso a datos del proyecto, propietario del proyecto o propietario del procesamiento de flujos 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
application/vnd.atlas.2024-08-05+json

Cuerpo Requerido

Detalles para crear un espacio de trabajo de transmisiones en el proyecto especificado.

Objeto Objeto

Respuestas

  • 200 application/vnd.atlas.2024-08-05+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • _id string

      Cadena de caracteres hexadecimales 24única que identifica el proyecto.

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

    • Conexiones matriz[objeto]

      Lista de conexiones configuradas en el espacio de trabajo de transmisión.

      Uno de:
      Objeto de muestra Objeto de clúster Kafka object Objeto https Objeto AWSLambda Objeto S3 Objeto AWSKinesisDataStreams Objeto SchemaRegistry
    • Región de proceso de datos Objeto

      Información sobre la región del proveedor de la nube en la que MongoDB Cloud procesa la transmisión.

      Ocultar atributos de dataProcessRegion Mostrar atributos de dataProcessRegion Objeto
      • Proveedor de la nube string Requerido

        Etiqueta legible por humanos que identifica al proveedor de la nube.

        Los valores son AWS, GCP, AZURE, TENANT o SERVERLESS.

      • enlaces matriz[objeto]

        Lista de uno o más uniform resource locators (URL) que apuntan a subrecursos de API, recursos API relacionados o ambos. RFC 5988 describe estas relaciones.

        Especificación de enlaces web (RFC...
        Ocultar atributos de enlaces Mostrar atributos de enlaces Objeto
        • href string

          Localizador Uniforme de Recursos (URL) que apunta a otro recurso de la API con el que esta respuesta guarda alguna relación. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

        • relación string

          Localizador Uniforme de Recursos (URL) que define la relación semántica entre este recurso y otro recurso de la API. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

      • región string Requerido

        Nombre de la región del proveedor de la nube que aloja Atlas Stream Processing.

        Uno de:
        ApiStreamsAWSRegionView string Cadena ApiStreamsAzureRegionView Cadena ApiStreamsGCPRegionView

        Regiones de AWS de Atlas Streams.

        Los valores son SYDNEY_AUS, MUMBAI_IND, FRANKFURT_DEU, DUBLIN_IRL, LONDON_GBR, VIRGINIA_USA, OHIO_USA, OREGON_USA, SAOPAULO_BRA, MONTREAL_CAN, TOKYO_JPN o SINGAPORE_SGP.

        Regiones de Azure de Atlas Streams.

        Los valores son eastus, westus, eastus2 o westeurope.

        Regiones de GCP de Atlas Streams.

        Los valores son US_CENTRAL1, EUROPE_WEST1 o US_EAST4.

    • ID de grupo string

      Cadena de caracteres hexadecimales 24única que identifica el proyecto.

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

    • nombres de host array[string]

      Lista que contiene los nombres de host asignados al espacio de trabajo de transmisión.

    • enlaces matriz[objeto]

      Lista de uno o más uniform resource locators (URL) que apuntan a subrecursos de API, recursos API relacionados o ambos. RFC 5988 describe estas relaciones.

      Especificación de enlaces web (RFC...
      Ocultar atributos de enlaces Mostrar atributos de enlaces Objeto
      • href string

        Localizador Uniforme de Recursos (URL) que apunta a otro recurso de la API con el que esta respuesta guarda alguna relación. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

      • relación string

        Localizador Uniforme de Recursos (URL) que define la relación semántica entre este recurso y otro recurso de la API. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

    • Nombre string

      Etiqueta que identifica el espacio de trabajo del stream.

    • Conexiones de muestra Objeto

      Conexiones de muestras para agregar a SPI.

      Ocultar atributos de sampleConnections Mostrar atributos de sampleConnections Objeto
      • enlaces matriz[objeto]

        Lista de uno o más uniform resource locators (URL) que apuntan a subrecursos de API, recursos API relacionados o ambos. RFC 5988 describe estas relaciones.

        Especificación de enlaces web (RFC...
        Ocultar atributos de enlaces Mostrar atributos de enlaces Objeto
        • href string

          Localizador Uniforme de Recursos (URL) que apunta a otro recurso de la API con el que esta respuesta guarda alguna relación. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

        • relación string

          Localizador Uniforme de Recursos (URL) que define la relación semántica entre este recurso y otro recurso de la API. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

      • solar booleano

        Bandera que indica si se debe agregar una conexión sample_stream_solar.

        El valor predeterminado es false.

    • streamConfig objeto | nulo

      Opciones de configuración para un espacio de trabajo de procesamiento de secuencias de Atlas.

      Ocultar atributos de streamConfig Mostrar atributos de streamConfig objeto | nulo
      • enlaces matriz[objeto]

        Lista de uno o más uniform resource locators (URL) que apuntan a subrecursos de API, recursos API relacionados o ambos. RFC 5988 describe estas relaciones.

        Especificación de enlaces web (RFC...
        Ocultar atributos de enlaces Mostrar atributos de enlaces Objeto
        • href string

          Localizador Uniforme de Recursos (URL) que apunta a otro recurso de la API con el que esta respuesta guarda alguna relación. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

        • relación string

          Localizador Uniforme de Recursos (URL) que define la relación semántica entre este recurso y otro recurso de la API. Esta URL suele empezar por https://cloud.mongodb.com/api/atlas.

      • tamaño máximo del nivel string

        Tamaño máximo de nivel para el espacio de trabajo de Stream. Configura las asignaciones de memoria y VCPU.

        Los valores son SP50, SP30, SP10, SP5 o SP2.

      • nivel string

        Nivel seleccionado para el espacio de trabajo de Stream. Configura las asignaciones de memoria y VCPU.

        Los valores son SP50, SP30, SP10, SP5 o SP2.
  • 400 aplicación/json

    Solicitud incorrecta.

    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.
  • 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.
POST /api/atlas/v2/groups/{groupId}/streams:conConexionesDeMuestra 
atlas api streams withStreamSampleConnections --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.WithGroupStreamSampleConnectionsApiParams{}
	sdkResp, httpResp, err := client.StreamsApi.
		WithGroupStreamSampleConnectionsWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" \
  -d '{ <Payload> }'
Solicitar ejemplos 
{}
Ejemplos de respuestas (200) 
{
  "_id": "32b6e34b3d91647abb20e7b8",
  "connections": [
    {
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "name": "string",
      "region": "string",
      "state": "PENDING",
      "type": "Sample"
    }
  ],
  "dataProcessRegion": {
    "cloudProvider": "AWS",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "region": "SYDNEY_AUS"
  },
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostnames": [
    "string"
  ],
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "name": "string",
  "sampleConnections": {
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "solar": false
  },
  "streamConfig": {
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ],
    "maxTierSize": "SP50",
    "tier": "SP50"
  }
}
Ejemplos de respuestas (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"
}
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"
}