オンデマンド スナップショット取り込みをトリガー
非推奨
指定されたスナップショットの Data Lake パイプラインの取り込みをトリガーします。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
Data Lake パイプラインを識別する、人間が判読可能なラベル。
形式は次のパターンと一致する必要があります:
^[^/\\ "$]{1,64}$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
POST /API/Atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}/trigger
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/pipelines/{pipelineName}/trigger' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"datasetRetentionPolicy":{"units":"DAYS","value":42},"snapshotId":"32b6e34b3d91647abb20e7b8"}'
リクエスト例
{
"datasetRetentionPolicy": {
"units": "DAYS",
"value": 42
},
"snapshotId": "32b6e34b3d91647abb20e7b8"
}
応答の例（200）
{
"_id": "32b6e34b3d91647abb20e7b8",
"backupFrequencyType": "HOURLY",
"createdDate": "2025-05-04T09:42:00Z",
"datasetName": "v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
"datasetRetentionPolicy": {
"lastModifiedDate": "2025-05-04T09:42:00Z",
"units": "DAYS",
"value": 42
},
"groupId": "32b6e34b3d91647abb20e7b8",
"lastUpdatedDate": "2025-05-04T09:42:00Z",
"phase": "SNAPSHOT",
"pipelineId": "32b6e34b3d91647abb20e7b8",
"scheduledDeletionDate": "2025-05-04T09:42:00Z",
"snapshotId": "32b6e34b3d91647abb20e7b8",
"state": "PENDING",
"stats": {
"bytesExported": 42,
"numDocs": 42
}
}
応答の例（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"
}