指定されたプロジェクトのすべてのストリーム ワークスペースを返します。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンスが返す 1 ページあたりのアイテムの数。
最小値は
1、最大値は500です。デフォルト値は100です。 -
レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。
の最小値は
1です。デフォルト値は1です。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
応答
-
OK
応答属性の非表示 応答属性の表示 オブジェクト
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
このリクエストの完了時にMongoDB Cloud が提供する返されたドキュメントのリスト。
結果属性を非表示にする 結果属性の表示 オブジェクト
-
プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
ストリーム ワークスペースで構成された接続のリスト。
次の 1 つ： 外部データ ストアへの接続を定義する設定。
属性を非表示 属性を表示
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム接続を識別する、人間に判読可能なラベル。サンプル タイプの場合、これはサンプル ソースの名前になります
-
接続の状態です。
値は、
PENDING、READY、DELETING、またはFAILEDです。 -
接続のタイプ。
値は
Sampleです。
外部データ ストアへの接続を定義する設定。
属性を非表示 属性を表示
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム接続を識別する、人間に判読可能なラベル。サンプル タイプの場合、これはサンプル ソースの名前になります
-
接続の状態です。
値は、
PENDING、READY、DELETING、またはFAILEDです。 -
接続のタイプ。
値は
Clusterです。 -
構成されたクラスターを含むプロジェクトを識別する一意の 24 桁の 16 進数文字列。 IDがストリーム ワークスペースを含むプロジェクトと一致しない場合に必要です。最初に、組織設定を有効にする必要があります。
-
この接続用に構成されたクラスターの名前。
-
Atlasクラスタに接続するための組み込みまたはカスタム DB ロールの名前。
dbRoleToExecute 属性を非表示にする dbRoleToExecute 属性を表示 オブジェクト
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
使用するロールの名前。組み込みロール またはカスタムロールにすることができます。
-
DB ロールのタイプ。組み込み または カスタム のいずれかを指定できます。
値は
BUILT_INまたはCUSTOMです。
-
外部データ ストアへの接続を定義する設定。
属性を非表示 属性を表示
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム接続を識別する、人間に判読可能なラベル。サンプル タイプの場合、これはサンプル ソースの名前になります
-
接続の状態です。
値は、
PENDING、READY、DELETING、またはFAILEDです。 -
接続のタイプ。
値は
Kafkaです。 -
Kafkaクラスターに接続するために必要なユーザー認証情報。認証タイプと、その認証モードのパラメータが含まれます。
認証属性の非表示 認証属性の表示 オブジェクト
-
Kafkaクラスターへの認証用の OIDCクライアント識別子。
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
認証のタイプ。PLAIN、SCRAM-256、SCRAM-512、または OAuth Bearer のいずれかになります。
-
SASL OAuth Bearer認証方法。現在は OIDC のみ可能です。
-
追加の OAuth2 構成用の SASL OAuth 拡張パラメータ。
-
要求されたアクセス権限を定義する OIDC スコープ パラメーター。
-
Kafkaへのクライアント認証用の SSL 証明書。
-
アクセス トークンを取得するための OIDC トークン エンドポイントURL 。
-
Kafkaクラスターに接続するためのアカウントのユーザー名。
-
-
サーバーアドレスのカンマ区切りリスト。
-
任意構成用のKafka のキーと値のペアのマップ。これは 平面オブジェクトであり、キーは「」を持つことができます。文字。
-
ストリーム接続のネットワーク構成。
ネットワーク属性の非表示 ネットワーク属性の表示 オブジェクト
-
ネットワーク アクセスに関する情報。
アクセス属性の非表示 アクセス属性の表示 オブジェクト
-
予約されています。 private_link 接続タイプで使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
予約されています。 private_link 接続タイプで使用されます。
-
予約されています。 TRANSIT_GATEBY 接続タイプで使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
選択したネットワークタイプ。 PUBLIC （デフォルトは PUBLIC です。 VPCの場合は、接続が正しく機能するために、 VPCピアリングが存在し、Atlas VPCとKafkaクラスターがホストされているVPC間で接続が確立されていることを確認します。 TRANSIT_GATEBY サポートは近日サポート予定です。
値は、
PUBLIC、VPC、PRIVATE_LINK、またはTRANSIT_GATEWAYです。
-
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC...
-
-
Kafkaへの安全なトランスポート接続のプロパティ。 SSL の場合、使用する信頼できる証明書をこれに含めることができます。
セキュリティ属性の非表示 セキュリティ属性の表示 オブジェクト
-
SSL 経由でKafkaに接続するための信頼できる公開 x509 証明書。
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
トランスポートの種類を説明します。 SASL_PLAINTXT、SASL_SSL、または SSL のいずれかになります。
-
外部データ ストアへの接続を定義する設定。
属性を非表示 属性を表示
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム接続を識別する、人間に判読可能なラベル。サンプル タイプの場合、これはサンプル ソースの名前になります
-
接続の状態です。
値は、
PENDING、READY、DELETING、またはFAILEDです。 -
接続のタイプ。
値は
Httpsです。 -
リクエストのヘッダーとして渡されるキーと値のペアのマップ。
-
リクエストに使用する URL 。
AWS Lambda接続の構成。
属性を非表示 属性を表示
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム接続を識別する、人間に判読可能なラベル。サンプル タイプの場合、これはサンプル ソースの名前になります
-
接続の状態です。
値は、
PENDING、READY、DELETING、またはFAILEDです。 -
接続のタイプ。
値は
AWSLambdaです。 -
Amazon Web Services ベースの接続タイプの Amazon Web Services 設定。
非表示の aws 属性 aws 属性の表示 オブジェクト
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
MongoDB Cloud が AWS アカウントのリソースにアクセスするときに引き受ける AWS（Amazon Web Services）ID と IAM（Identity and Access Management、ID とアクセス管理）ロールを識別する、ARN（Amazon Resource Name、Amazon リソース ネーム）です。
-
渡された IAM ロール ARN の認可を確認するために使用される S3バケットの名前。
-
S3 接続の構成。
属性を非表示 属性を表示
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム接続を識別する、人間に判読可能なラベル。サンプル タイプの場合、これはサンプル ソースの名前になります
-
接続の状態です。
値は、
PENDING、READY、DELETING、またはFAILEDです。 -
接続のタイプ。
-
Amazon Web Services ベースの接続タイプの Amazon Web Services 設定。
非表示の aws 属性 aws 属性の表示 オブジェクト
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
MongoDB Cloud が AWS アカウントのリソースにアクセスするときに引き受ける AWS（Amazon Web Services）ID と IAM（Identity and Access Management、ID とアクセス管理）ロールを識別する、ARN（Amazon Resource Name、Amazon リソース ネーム）です。
-
渡された IAM ロール ARN の認可を確認するために使用される S3バケットの名前。
-
-
ストリーム接続のネットワーク構成。
ネットワーク属性の非表示 ネットワーク属性の表示 オブジェクト
-
ネットワーク アクセスに関する情報。
アクセス属性の非表示 アクセス属性の表示 オブジェクト
-
予約されています。 private_link 接続タイプで使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
予約されています。 private_link 接続タイプで使用されます。
-
予約されています。 TRANSIT_GATEBY 接続タイプで使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
選択したネットワークタイプ。 PUBLIC （デフォルトは PUBLIC です。 VPCの場合は、接続が正しく機能するために、 VPCピアリングが存在し、Atlas VPCとKafkaクラスターがホストされているVPC間で接続が確立されていることを確認します。 TRANSIT_GATEBY サポートは近日サポート予定です。
値は、
PUBLIC、VPC、PRIVATE_LINK、またはTRANSIT_GATEWAYです。
-
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC...
-
AWS Kinesis Data Stream 接続の構成。
属性を非表示 属性を表示
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム接続を識別する、人間に判読可能なラベル。サンプル タイプの場合、これはサンプル ソースの名前になります
-
接続の状態です。
値は、
PENDING、READY、DELETING、またはFAILEDです。 -
接続のタイプ。
値は
AWSKinesisDataStreamsです。 -
Amazon Web Services ベースの接続タイプの Amazon Web Services 設定。
非表示の aws 属性 aws 属性の表示 オブジェクト
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
MongoDB Cloud が AWS アカウントのリソースにアクセスするときに引き受ける AWS（Amazon Web Services）ID と IAM（Identity and Access Management、ID とアクセス管理）ロールを識別する、ARN（Amazon Resource Name、Amazon リソース ネーム）です。
-
渡された IAM ロール ARN の認可を確認するために使用される S3バケットの名前。
-
-
ストリーム接続のネットワーク構成。
ネットワーク属性の非表示 ネットワーク属性の表示 オブジェクト
-
ネットワーク アクセスに関する情報。
アクセス属性の非表示 アクセス属性の表示 オブジェクト
-
予約されています。 private_link 接続タイプで使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
予約されています。 private_link 接続タイプで使用されます。
-
予約されています。 TRANSIT_GATEBY 接続タイプで使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
選択したネットワークタイプ。 PUBLIC （デフォルトは PUBLIC です。 VPCの場合は、接続が正しく機能するために、 VPCピアリングが存在し、Atlas VPCとKafkaクラスターがホストされているVPC間で接続が確立されていることを確認します。 TRANSIT_GATEBY サポートは近日サポート予定です。
値は、
PUBLIC、VPC、PRIVATE_LINK、またはTRANSIT_GATEWAYです。
-
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC...
-
スキーマ レジストリ接続の構成。
属性を非表示 属性を表示
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム接続を識別する、人間に判読可能なラベル。サンプル タイプの場合、これはサンプル ソースの名前になります
-
接続の状態です。
値は、
PENDING、READY、DELETING、またはFAILEDです。 -
接続のタイプ。
値は
SchemaRegistryです。 -
スキーマ レジストリ プロバイダー。
値は
CONFLUENTです。 -
この接続で使用されるスキーマ レジストリ エンドポイント URL のリスト。各URLでは、HTTP または HTTPS スキームを使用し、有効なホストとオプションのポートを指定する必要があります。
10要素以下
-
-
MongoDB Cloud がストリームを処理するクラウドプロバイダーのリージョンに関する情報。
dataProcessRegion 属性を非表示にする dataProcessRegion 属性の表示 オブジェクト
-
クラウドプロバイダーを識別する、人間が判読できるラベル。
値は、
AWS、GCP、AZURE、TENANT、またはSERVERLESSです。 -
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... リージョン
string 必須 Atlas Stream Processing をホストするクラウド プロバイダー リージョンの名前。
次の 1 つ： Atlas は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です。
-
-
プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
ストリーム ワークスペースに割り当てられたホスト名が格納されたリスト。
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム ワークスペースを識別するラベル。
-
SPI に追加するサンプル接続。
sampleConnections 属性を非表示にする sampleConnections 属性の表示 オブジェクト
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
「sample_stream_solver」接続を追加するかどうかを示すフラグ。
デフォルト値は
falseです。
-
-
Atlas Stream Processing ワークスペースの構成オプション。
streamConfig 属性を非表示にする streamConfig 属性の表示 オブジェクト| null
-
APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
Web リンク仕様（RFC... -
ストリーム ワークスペースの最大階層サイズ。メモリ / VCPU の許可を設定します。
値は、
SP50、SP30、SP10、SP5、またはSP2です。 -
ストリーム ワークスペースに選択した階層。メモリ / VCPU の許可を設定します。
値は、
SP50、SP30、SP10、SP5、またはSP2です。
-
-
-
使用可能なドキュメントの合計数。
includeCountがfalseに設定されている場合、 MongoDB Cloud はこの値を省略します。合計数は推定値であり、正確でない場合があります。の最小値は
0です。
-
-
許可されていません。
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
-
Forbidden.
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
-
見つかりません。
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
-
内部サーバーエラー。
応答属性の非表示 応答属性の表示 オブジェクト
-
無効なリクエストの詳細。
-
各タイプのエラーの原因となる特定の条件または理由について説明します。
-
このエラーで返された HTTP ステータス コード。
外部ドキュメント -
このエラーで返されたアプリケーション エラー コード。
-
エラーに関する詳細情報を提供するために使用されるパラメーター。
-
このエラーで返されたアプリケーション エラー メッセージ。
-
atlas api streams listStreamWorkspaces --helpimport (
"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"{
"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",
"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"
}
}
],
"totalCount": 42
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}