얻다 /api/atlas/v2/groups/{groupId}/streams/{tenantName}
서비스 계정 DigestAuth

지정된 프로젝트 내 스트림 작업 공간 한 개에 대한 세부 정보를 반환합니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 역할, 프로젝트 소유자 역할 또는 프로젝트 Stream Processing 소유자 역할 있어야 합니다.

경로 매개변수

  • groupId 문자열 필수 사항

    프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.

    참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • tenantName 문자열 필수 사항

    반환할 스트림 작업 공간을 식별하는 레이블입니다.

쿼리 매개변수

  • envelope 부울

    애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

    기본값은 false 입니다.

  • includeConnections 부울

    스트림 작업 공간에 연결 정보를 포함할지 여부를 나타내는 플래그입니다.

응답

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

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • _id 문자열

      프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.

      형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • 연결 배열[객체]

      스트림 작업 공간에 구성된 연결 목록입니다.

      다음 중 하나입니다.
      샘플 객체 클러스터 객체 Kafka object Https 객체 AWSLambda 객체 S3 객체 AWSKinesisDataStreams 객체 SchemaRegistry 객체
    • dataProcessRegion 객체

      MongoDB 클라우드가 스트림을 처리하는 클라우드 공급자 리전에 대한 정보입니다.

      dataProcessRegion 속성 숨기기 dataProcessRegion 속성 표시 객체
      • cloudProvider 문자열 필수 사항

        cloud 제공자 식별하는 사람이 읽을 수 있는 레이블입니다.

        값은 AWS, GCP, AZURE, TENANT 또는 SERVERLESS입니다.

      • 링크 배열[객체]

        API 하위 리소스, 관련 API 리소스 또는 둘 다를 점 하나 이상의 URL(Uniform Resource Locator) 목록입니다. RFC 5988 는 이러한 관계를 간략하게 설명합니다.

        웹 연결 사양(RFC...
        링크 속성 숨기기 링크 속성 표시 객체
        • href 문자열

          이 응답과 관계 있는 다른 API 리소스 가리키는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

        • rel 문자열

          이 리소스 와 다른 API 리소스 간의 의미론적 관계 정의하는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

      • 리전 문자열 필수 사항

        Atlas Stream Processing을 호스팅하는 클라우드 공급자 리전의 이름입니다.

        다음 중 하나입니다.
        ApiStreamsAWSRegionView 문자열 ApiStreamsAzureRegionView 문자열 ApiStreamsGCPRegionView 문자열

        Atlas Streams AWS 리전.

        값은 SYDNEY_AUS, MUMBAI_IND, FRANKFURT_DEU, DUBLIN_IRL, LONDON_GBR, VIRGINIA_USA, OHIO_USA, OREGON_USA, SAOPAULO_BRA, MONTREAL_CAN, TOKYO_JPN 또는 SINGAPORE_SGP입니다. .

        Atlas Streams Azure 리전.

        값은 eastus, westus, eastus2 또는 westeurope입니다.

        Atlas Streams GCP 리전.

        값은 US_CENTRAL1, EUROPE_WEST1 또는 US_EAST4입니다.

    • groupId 문자열

      프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.

      형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • 호스트 이름 array[string]

      스트림 작업 공간에 할당된 호스트 이름이 포함된 목록입니다.

    • 링크 배열[객체]

      API 하위 리소스, 관련 API 리소스 또는 둘 다를 점 하나 이상의 URL(Uniform Resource Locator) 목록입니다. RFC 5988 는 이러한 관계를 간략하게 설명합니다.

      웹 연결 사양(RFC...
      링크 속성 숨기기 링크 속성 표시 객체
      • href 문자열

        이 응답과 관계 있는 다른 API 리소스 가리키는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

      • rel 문자열

        이 리소스 와 다른 API 리소스 간의 의미론적 관계 정의하는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

    • 이름 문자열

      스트림 작업 공간을 식별하는 레이블입니다.

    • sampleConnections 객체

      SPI에 추가할 샘플 연결입니다.

      sampleConnections 속성 숨기기 sampleConnections 속성 표시 객체
      • 링크 배열[객체]

        API 하위 리소스, 관련 API 리소스 또는 둘 다를 점 하나 이상의 URL(Uniform Resource Locator) 목록입니다. RFC 5988 는 이러한 관계를 간략하게 설명합니다.

        웹 연결 사양(RFC...
        링크 속성 숨기기 링크 속성 표시 객체
        • href 문자열

          이 응답과 관계 있는 다른 API 리소스 가리키는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

        • rel 문자열

          이 리소스 와 다른 API 리소스 간의 의미론적 관계 정의하는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

      • solar 부울

        sample_stream_solar 연결을 추가할지 여부를 나타내는 플래그입니다.

        기본값은 false 입니다.

    • streamConfig 객체 | null

      Atlas Stream Processing Workspace의 구성 옵션입니다.

      streamConfig 속성 숨기기 streamConfig 속성 표시 객체 | null
      • 링크 배열[객체]

        API 하위 리소스, 관련 API 리소스 또는 둘 다를 점 하나 이상의 URL(Uniform Resource Locator) 목록입니다. RFC 5988 는 이러한 관계를 간략하게 설명합니다.

        웹 연결 사양(RFC...
        링크 속성 숨기기 링크 속성 표시 객체
        • href 문자열

          이 응답과 관계 있는 다른 API 리소스 가리키는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

        • rel 문자열

          이 리소스 와 다른 API 리소스 간의 의미론적 관계 정의하는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

      • maxTierSize 문자열

        Stream Workspace의 최대 계층 크기입니다. 메모리/VCPU 허용량을 구성합니다.

        값은 SP50, SP30, SP10, SP5 또는 SP2입니다.

      • tier 문자열

        Stream Workspace에 대해 선택된 계층 . 메모리/VCPU 허용량을 구성합니다.

        값은 SP50, SP30, SP10, SP5 또는 SP2입니다.
  • 400 application/json

    잘못된 요청입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 401 application/json

    승인되지 않았습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 403 application/json

    Forbidden.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
GET /API/Atlas/v2/groups/{groupId}/streams/{tenantName} 
atlas api streams getStreamWorkspace --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.GetGroupStreamWorkspaceApiParams{}
	sdkResp, httpResp, err := client.StreamsApi.
		GetGroupStreamWorkspaceWithParams(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/{tenantName}?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/{tenantName}?pretty=true"
응답 예시(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"
  }
}
응답 예시(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"
}
응답 예시(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"
}
응답 예시(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"
}
응답 예시(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"
}
응답 예시(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"
}