1 つのプロジェクト内のすべてのデータレイク パイプラインを返す 非推奨

GET /api/atlas/v2/groups/{groupId}/pipelines

Data Lake パイプラインの一覧を返します。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。

path パラメータ

  • グループ ID string 必須

    プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

    : グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

    形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

クエリ パラメータ

  • envelope ブール値

    アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

    デフォルト値はfalseです。

応答

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

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • _id string

      Data Lake パイプラインを識別する一意な 24 桁の 16 進数の文字列。

      形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

    • createdDate string(date-time)

      Data Lake パイプラインが作成された時間を示すタイムスタンプ。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

    • datasetRetentionPolicy オブジェクト

      スケジュールされた Data Lake パイプラインのデータセット保持ポリシー。

      datasetRetentionPolicy 属性を非表示にする datasetRetentionPolicy 属性の表示 オブジェクト
      • lastModifiedDate string(date-time)

        保持ポリシーが最後に変更された日付。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • 単位 string 必須

        Data Lake パイプラインがデータセットの保持を測定する時間の量。

        値は DAYSWEEKS、または MONTHS です。

      • 価値 integer(int32) 必須

        Data Lake パイプラインがデータセットを保持する日数、週数、月数を示す数値。

        の最小値は 1 です。

    • グループ ID string

      グループを識別する一意な 24 桁の 16 進数の文字列。

      形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$

    • lastUpdatedDate string(date-time)

      Data Lake パイプラインが最後に更新された時刻を示すタイムスタンプ。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

    • name string

      この Data Lake パイプラインの名前。

    • sink オブジェクト

      Data Lake パイプラインの宛先としての Atlas Data Lake ストレージ。

      Sink 属性の非表示 Sink 属性の表示 オブジェクト
      • タイプ string 弁別子

        この Data Lake パイプラインの取り込み先のタイプ。

        値は DLS です。

      • metadataProvider string

        この Data Lake パイプラインのターゲットクラウドプロバイダー。

        値は AWS です。

      • metadataRegion string

        この Data Lake パイプラインのターゲットクラウドプロバイダーリージョン。

        サポートされているクラウドプロバイダーのリージョン
      • partitionFields array[オブジェクト]

        宛先内のデータを物理的に整理するために使用される順序付きフィールド。

        Data Lake パイプラインの Data Lake ストレージ プロバイダーのパーティション フィールド。

        partitionFields 属性を非表示にする partitionFields 属性の表示 オブジェクト
        • フィールド名 string 必須

          データの分割に使用されるフィールド名を識別する、人間が判読可能なラベル。

          最大長は 700 です。

        • ordered integer(int32) 必須

          MongoDB Cloud がコレクションデータをスライスしてパーティションを作成するシーケンス。リソースは、ゼロから始まるこのシーケンスを表します。

          デフォルト値は0です。

    • ソース オブジェクト

      次の 1 つ:
    • 状態 string

      この Data Lake パイプラインの状態。

      値は ACTIVE または PAUSED です。

    • transformations array[オブジェクト]

      この Data Lake パイプラインで除外するフィールド。

      Data Lake パイプラインの取り込み中のフィールド変換。

      変換属性を非表示にする 変換属性の表示 オブジェクト
      • フィールド string

        ドキュメントのキー。

      • タイプ string

        Data Lake パイプラインで名前空間のエクスポート中に適用される変換のタイプ。

        値は EXCLUDE です。

  • 400 application/ JSON

    無効なリクエストです。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 401 application/ JSON

    許可されていません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 403 application/ JSON

    Forbidden.

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 404 application/ JSON

    見つかりません。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

  • 500 application/ JSON

    内部サーバーエラー。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      無効なリクエストの詳細。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        クライアントリクエストにおけるすべての違反を説明します。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト
        • 説明 string 必須

          リクエスト要素が禁止されている理由の説明。

        • フィールド string 必須

          リクエスト本文内のフィールドにつながるパス。

    • 詳細 string

      各タイプのエラーの原因となる特定の条件または理由について説明します。

    • エラー integer(int32) 必須

      このエラーで返された HTTP ステータス コード。

      外部ドキュメント
    • errorCode string 必須

      このエラーで返されたアプリケーション エラー コード。

    • パラメーター array[オブジェクト]

      エラーに関する詳細情報を提供するために使用されるパラメーター。

    • 理由 string

      このエラーで返されたアプリケーション エラー メッセージ。

atlas api dataLakePipelines listGroupPipelines --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241023001/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.ListGroupPipelinesApiParams{}
	sdkResp, httpResp, err := client.DataLakePipelinesApi.
		ListGroupPipelinesWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true"
応答の例(200)
[
  {
    "_id": "32b6e34b3d91647abb20e7b8",
    "createdDate": "2025-05-04T09:42:00Z",
    "datasetRetentionPolicy": {
      "lastModifiedDate": "2025-05-04T09:42:00Z",
      "units": "DAYS",
      "value": 42
    },
    "groupId": "32b6e34b3d91647abb20e7b8",
    "lastUpdatedDate": "2025-05-04T09:42:00Z",
    "name": "string",
    "sink": {
      "type": "DLS",
      "metadataProvider": "AWS",
      "metadataRegion": "string",
      "partitionFields": [
        {
          "fieldName": "string",
          "order": 0
        }
      ]
    },
    "source": {
      "type": "ON_DEMAND_CPS",
      "clusterName": "string",
      "collectionName": "string",
      "databaseName": "string",
      "groupId": "32b6e34b3d91647abb20e7b8"
    },
    "state": "ACTIVE",
    "transformations": [
      {
        "field": "string",
        "type": "EXCLUDE"
      }
    ]
  }
]
応答の例(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"
}