1 つの M2 または M5 クラスターのすべてのスナップショットを返す非推奨

GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots

指定された共有クラスターのすべてのスナップショットの詳細を返します。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーに Project Read Only ロールが必要です。

このAPI は、createCluster エンドポイントを使用して作成された Flex クラスター、または2 5Flex クラスターに移行された以前の M /M2026 クラスターにも機能します。その後、このエンドポイントは廃止されます。代わりに listFlexBackups エンドポイントを使用してください。

listFlexBackups

path パラメータ

グループ ID string 必須

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

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

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

クラスターを識別する人間が判読できるラベル。

形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。

クエリパラメータ

envelope ブール値

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

デフォルト値はfalseです。
pretty ブール値

レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。

デフォルト値はfalseです。

Prettyprint

応答

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

OK
応答属性の非表示応答属性の表示オブジェクト
- Links array[オブジェクト]
  
  APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
  
  Web リンク仕様（RFC 5988）
  
  リンク属性を非表示にするリンク属性を表示するオブジェクト
  
  href string
  
  この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
  
  リリース string
  
  このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
- 結果 array[オブジェクト]
  
  このリクエストの完了時にMongoDB Cloud が提供する返されたドキュメントのリスト。
  
  結果属性を非表示にする結果属性の表示オブジェクト
  
  有効期限 string(date-time)
  
  ダウンロードリンクが機能しなくなった日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
  
  finalTime string(date-time)
  
  MongoDB Cloud がこのスナップショットの書き込みを完了した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
  
  id string
  
  復元ジョブを識別するユニークな 24 桁の 16 進数文字列。
  
  形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
  
  Links array[オブジェクト]
  
  APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。
  
  Web リンク仕様（RFC 5988）
  
  リンク属性を非表示にするリンク属性を表示するオブジェクト
  
  href string
  
  この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
  
  リリース string
  
  このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。
  
  mongoDBVersion string
  
  スナップショットが実行されるMongoDBホストバージョン。
  
  scheduledTime string(date-time)
  
  MongoDB Cloud がスナップショットを取得する日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
  
  startTime string(date-time)
  
  MongoDB Cloud がスナップショットの取得を開始した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。
  
  状態 string
  
  このリソースがこのリクエストを行った時点での、このスナップリクエストのワークフローのフェーズ。
  
  値は、PENDING、QUEUED、RUNNING、FAILED、または COMPLETED です。
- totalCount integer(int32)
  
  使用可能なドキュメントの合計数。includeCount が false に設定されている場合、 MongoDB Cloud はこの値を省略します。合計数は推定値であり、正確でない場合があります。
  
  の最小値は 0 です。
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
  
  このエラーで返されたアプリケーションエラーメッセージ。

GET /API/Atlas/v2/groups/{groupId}/clusters/{clusterName}/バックアップ/tenant/snapshots

atlas api sharedTierSnapshots listSharedClusterBackups --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.ListSharedClusterBackupsApiParams{}
	sdkResp, httpResp, err := client.Shared - TierSnapshotsApi.
		ListSharedClusterBackupsWithParams(ctx, params).
		Execute()
}

curl --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}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true"

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true"

応答の例（200）

{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "expiration": "2025-05-04T09:42:00Z",
      "finishTime": "2025-05-04T09:42:00Z",
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "mongoDBVersion": "string",
      "scheduledTime": "2025-05-04T09:42:00Z",
      "startTime": "2025-05-04T09:42:00Z",
      "status": "PENDING"
    }
  ],
  "totalCount": 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"
}

1 つの M2 または M5 クラスターのすべてのスナップショットを返す 非推奨

path パラメータ

クエリ パラメータ

応答

1 つの M2 または M5 クラスターのすべてのスナップショットを返す非推奨

クエリパラメータ