PARCHE /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}

Modifique un procesador de flujo existente dentro del espacio de trabajo de flujo especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de propietario del proyecto o del procesador de flujo 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})$.

  • nombre del inquilino string Requerido

    Etiqueta que identifica el espacio de trabajo del stream.

  • nombre del procesador string Requerido

    Etiqueta que identifica el procesador del flujo.

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-05-30+json

Cuerpo Requerido

Modificaciones para aplicar al procesador de streams.

  • Nombre string

    Nuevo nombre para el procesador de flujo.

  • opciones Objeto

    Opciones adicionales para modificar un procesador de flujo.

    Ocultar atributos de opciones Mostrar atributos de opciones Objeto
    • dlq Objeto

      Cola de mensajes muertos para el procesador de flujo.

      Documentación externa
      Ocultar atributos dlq Mostrar atributos dlq Objeto
      • coll string

        Nombre de la colección a utilizar para el DLQ.

      • nombreDeConexión string

        Nombre de la conexión donde se escribirán los mensajes DLQ. Debe ser una conexión Atlas.

      • db string

        Nombre de la base de datos a utilizar para el DLQ.

    • reanudarDesdePuntoDeControl booleano

      Si se activa, el procesador de flujo modificado se reanuda desde su último punto de control.

  • pipeline matriz[objeto]

    Nueva tubería para el procesador de flujo.

    Canalización de agregación compatible...
    Ocultar atributo de canalización Mostrar atributo de canalización Objeto
    • * Objeto Propiedades adicionales

Respuestas

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

    Vale

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

      Cadena de caracteres hexadecimales 24única que identifica al procesador de flujo.

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

    • Nombre string Requerido

      Nombre legible para humanos del procesador de flujos.

    • opciones Objeto

      Configuración opcional para el procesador de flujo.

      Ocultar atributos de opciones Mostrar atributos de opciones Objeto
      • dlq Objeto

        Cola de mensajes muertos para el procesador de flujo.

        Documentación externa
        Ocultar atributos dlq Mostrar atributos dlq Objeto
        • coll string

          Nombre de la colección a utilizar para el DLQ.

        • nombreDeConexión string

          Nombre de la conexión donde se escribirán los mensajes DLQ. Debe ser una conexión Atlas.

        • db string

          Nombre de la base de datos a utilizar para el DLQ.

    • pipeline matriz[objeto] Requerido

      Canal de agregación de transmisiones que desea aplicar a sus datos de transmisión.

      Ocultar atributo de canalización Mostrar atributo de canalización Objeto
      • * Objeto Propiedades adicionales
    • Estado string Requerido

      El estado del procesador de flujo. Los estados más comunes son "CREADO", "INICIADO", "DETENIDO" y "FALLIDO".

    • stats Objeto

      Las estadísticas asociadas con el procesador de flujo.

      Documentación externa
      Ocultar atributo de estadísticas Mostrar atributo de estadísticas Objeto
    • 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.

PARCHE /api/atlas/v2/grupos/{ID de grupo}/streams/{nombre del inquilino}/procesador/{nombre del procesador}
atlas api streams updateStreamProcessor --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.UpdateGroupStreamProcessorApiParams{}
	sdkResp, httpResp, err := client.StreamsApi.
		UpdateGroupStreamProcessorWithParams(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 PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" \
  -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 PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" \
  -d '{ <Payload> }'
Solicitar ejemplos
{
  "name": "string",
  "options": {
    "dlq": {
      "coll": "string",
      "connectionName": "string",
      "db": "string"
    },
    "resumeFromCheckpoint": true
  },
  "pipeline": [
    {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  ]
}
Ejemplos de respuestas (200)
{
  "_id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "name": "string",
  "options": {
    "dlq": {
      "coll": "string",
      "connectionName": "string",
      "db": "string",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ]
    },
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ]
  },
  "pipeline": [
    {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  ],
  "state": "string",
  "stats": {
    "additionalProperty1": {},
    "additionalProperty2": {}
  },
  "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"
}