Retornar todos os espaços de trabalho de fluxo em um projeto

OBTER /api/atlas/v2/groups/{groupId}/streams
Contas de serviço DigestAuth

Retorna todos os espaços de trabalho de stream do projeto especificado.

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

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.

  • itemsPerPage inteiro

    Número de itens que a resposta retorna por página.

    O valor mínimo é 1, o valor máximo é 500. O valor padrão é 100.

  • pageNum inteiro

    Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

    O valor mínimo é 1. O valor padrão é 1.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint

Respostas

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

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • links array[objeto]

      Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.

      Especificação de links da web (RFC...
      Ocultar atributos dos links Mostrar atributos dos links objeto
      • href string

        Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

      • rel string

        Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

    • Resultados array[objeto]

      Lista de documentos retornados que o MongoDB Cloud fornece ao concluir esta solicitação.

      Ocultar atributos de resultados Mostrar atributos de resultados objeto
      • _id string

        String exclusiva de 24 caracteres hexadecimais que identifica o projeto.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • conexões array[objeto]

        Lista de conexões configuradas no espaço de trabalho do stream.

        Um dos seguintes:
        objeto de amostra objeto de cluster Kafka object objeto HTTPS objeto AWSLambda objeto S3 objeto AWSKinesisDataStreams
      • dataProcessRegion objeto

        Informações sobre a região do provedor de nuvem na qual o MongoDB Cloud processa o fluxo.

        Ocultar atributos dataProcessRegion Mostrar atributos de dataProcessRegion objeto
        • cloudProvider string Obrigatório

          Rótulo que identifica o provedor de serviços de nuvem onde o MongoDB Cloud executa o processamento de fluxo. Atualmente, esse parâmetro é compatível apenas com AWS e AZURE.

          Os valores são AWS, GCP, AZURE, TENANT ou SERVERLESS.

        • links array[objeto]

          Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.

          Especificação de links da web (RFC...
          Ocultar atributos dos links Mostrar atributos dos links objeto
          • href string

            Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

          • rel string

            Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

        • região string Obrigatório

          Nome da região do provedor de nuvem hospedando o Atlas Stream Processing.

          Um dos seguintes:
          ApiStreamsAWSRegionView string ApiStreamsAzureRegionView string String ApiStreamsGCPRegionView

          Atlas transmite regiões da AWS .

          Os valores são SYDNEY_AUS, MUMBAI_IND, FRANKFURT_DEU, DUBLIN_IRL, LONDON_GBR, VIRGINIA_USA, OHIO_USA, OREGON_USA, SAOPAULO_BRA, MONTREAL_CAN, TOKYO_JPN ou SINGAPORE_SGP.

          Atlas Streams Azure Regiões.

          Os valores são eastus, westus, eastus2 ou westeurope.

          Regiões do GCP do Atlas Streams.

          Os valores são US_CENTRAL1, EUROPE_WEST1 ou US_EAST4.

      • groupId string

        String exclusiva de 24 caracteres hexadecimais que identifica o projeto.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • nomes de host array[string]

        Lista que contém os nomes de host atribuídos ao espaço de trabalho do stream.

      • links array[objeto]

        Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.

        Especificação de links da web (RFC...
        Ocultar atributos dos links Mostrar atributos dos links objeto
        • href string

          Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

        • rel string

          Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

      • name string

        Etiqueta que identifica o espaço de trabalho do fluxo.

      • sampleConnections objeto

        Conexões de amostra para adicionar ao SPI.

        Ocultar atributos sampleConnections Mostrar atributos sampleConnections objeto
        • links array[objeto]

          Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.

          Especificação de links da web (RFC...
          Ocultar atributos dos links Mostrar atributos dos links objeto
          • href string

            Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

          • rel string

            Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

        • solar booleano

          Sinalizador que indica se uma conexão 'sample_stream_solar' deve ser adicionada.

          O valor padrão é false.

      • streamConfig objeto | zero

        Opções de configuração para um Atlas Stream Processing .

        Ocultar atributos streamConfig Mostrar atributos streamConfig objeto | zero
        • links array[objeto]

          Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.

          Especificação de links da web (RFC...
          Ocultar atributos dos links Mostrar atributos dos links objeto
          • href string

            Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

          • rel string

            Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

        • maxTierSize string

          Tamanho máximo da camada para o Stream Workspace. Configura as permissões de Memória/VCPU.

          Os valores são SP50, SP30, SP10, SP5 ou SP2.

        • nível string

          Camada selecionada para o Stream Workspace. Configura as permissões de Memória/VCPU.

          Os valores são SP50, SP30, SP10, SP5 ou SP2.

    • contagem total integer(int32)

      Número total de documentos disponíveis. O MongoDB Cloud omite este valor se includeCount estiver definido como false. O número total é uma estimativa e pode não ser exato.

      O valor mínimo é 0.
  • 401 aplicação/json

    Não autorizado.

    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.
  • 403 aplicação/json

    Forbidden.

    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.
  • 404 aplicação/json

    Não encontrado.

    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.
  • 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/groups/{groupId}/streams 
atlas api streams listStreamWorkspaces --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.ListGroupStreamWorkspacesApiParams{}
	sdkResp, httpResp, err := client.StreamsApi.
		ListGroupStreamWorkspacesWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true"
Exemplos de resposta (200) 
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "_id": "32b6e34b3d91647abb20e7b8",
      "connections": [
        {
          "links": [
            {
              "href": "https://cloud.mongodb.com/api/atlas",
              "rel": "self"
            }
          ],
          "name": "string",
          "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"
      }
    }
  ],
  "totalCount": 42
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
Exemplos de resposta (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"
}
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"
}