スナップショットスケジュールを更新

項目一覧

Resource

Request Parameters
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

Cloud Manager は、 2024年8月30日でMongoDB 3.6と4.0のオートメーション、バックアップおよびモニタリングのサポートを終了します。 MongoDB の配置をアップグレードするか、Atlas に移行してください。

Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。: 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用するサービスアカウントを作成します。

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。このページでは、説明を参照するときに、より一般的な用語のグループを使用します。エンドポイントはドキュメントに記載されているままです。

Resource

PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule

Request Parameters

リクエストパスパラメーター

Parameter	タイプ	必要性	説明
`PROJECT-ID`	string	必須	更新対象のスナップショットスケジュールを持つクラスターを保持するプロジェクトの一意の識別子。
`CLUSTER-ID`	string	必須	更新対象のスナップショットスケジュールを持つクラスターの一意の識別子です。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

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

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

リクエストボディパラメータ

名前	タイプ	必要性	説明
`clusterCheckpointIntervalMin`	数値	任意	連続するクラスターチェックポイント間の分数。これは、シャーディングされたクラスターにのみ適用されます。この数値により、シャーディングされたクラスターのポイントインタイム復元の粒度が決まります。 `15` 、 `30` 、または`60`の値を設定できます。重要: `Feature Compatibility Version`4.0またはそれ以前のでMongoDBを実行するクラスターにはチェックポイントを使用できます。FCV を持つMongoDBインスタンスからチェックポイントが削除されました。4 2以降。
`clusterId`	string	任意	このバックアップ構成が適用されるクラスターの一意の識別子。
`dailySnapshotRetentionDays`	数値	任意	日次スナップショットを保持する日数。 `1`から`365`までの値を設定できます。 `dailySnapshotRetentionDays`を`0`に設定すると、このルールが無効になります。
`fullIncrementalDayOfWeek`	string	任意	Cloud Manager が完全なスナップショットを取得する曜日。これにより、最新の完全なバックアップが保証されます。 Cloud Manager はデフォルト値をランダムな曜日に設定します。
`groupId`	string	任意	バックアップ構成を所有するプロジェクトの一意の識別子です。
`links`	オブジェクトの配列	任意	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`monthlySnapshotRetentionMonths`	数値	任意	月次スナップショットを保持する月数。 `1`から`36`までの値を設定できます。 `monthlySnapshotRetentionMonths`を`0`に設定すると、このルールが無効になります。
`snapshotIntervalHours`	数値	任意	スナップショット間の時間数。 `6` 、 `8` 、 `12` 、または`24`の値を設定できます。
`snapshotRetentionDays`	数値	任意	最近のスナップショットを保持する日数。 `2`から`5`までの値を設定できます。
`weeklySnapshotRetentionWeeks`	数値	任意	週次スナップショットを保持する週数。 `1`から`52`までの値を設定できます。 `weeklySnapshotRetentionWeeks`を`0`に設定すると、このルールが無効になります。

応答

名前	タイプ	説明
`clusterCheckpointIntervalMin`	数値	連続するクラスターチェックポイント間の分数。これは、シャーディングされたクラスターにのみ適用されます。この数値により、シャーディングされたクラスターのポイントインタイム復元の粒度が決まります。 Cloud Manager は、 `15` 、 `30` 、または`60`の値を返す場合があります。重要: `Feature Compatibility Version`4.0またはそれ以前のでMongoDBを実行するクラスターにはチェックポイントを使用できます。FCV を持つMongoDBインスタンスからチェックポイントが削除されました。4 2以降。
`clusterId`	string	このバックアップ構成が適用されるクラスターの一意の識別子。
`dailySnapshotRetentionDays`	数値	日次スナップショットを保持する日数。 Cloud Manager は、 `1`から`365`までの値を返す場合があります。 `dailySnapshotRetentionDays`を`0`に設定すると、このルールが無効になります。
`fullIncrementalDayOfWeek`	string	Cloud Manager が完全なスナップショットを取得する曜日。これにより、最新の完全なバックアップが保証されます。 Cloud Manager はデフォルト値をランダムな曜日に設定します。
`groupId`	string	バックアップ構成を所有するプロジェクトの一意の識別子です。
`links`	オブジェクトの配列	サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての`links`配列には、 `self`と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様で説明されています。
`monthlySnapshotRetentionMonths`	数値	月次スナップショットを保持する月数。 Cloud Manager は、 `1`から`36`までの値を返す場合があります。 `monthlySnapshotRetentionMonths`を`0`に設定すると、このルールが無効になります。
`pointInTimeWindowHours`	数値	ポイントインタイムスナップショットを作成できる過去の時間数。スナップショットの場合、この値を変更することはできません。
`snapshotIntervalHours`	数値	スナップショット間の時間数。 Cloud Manager は、 `6` 、 `8` 、 `12` 、または`24`の値を返す場合があります。
`snapshotRetentionDays`	数値	最近のスナップショットを保持する日数。 Cloud Manager は、 `2`から`5`までの値を返す場合があります。
`weeklySnapshotRetentionWeeks`	数値	週次スナップショットを保持する週数。 Cloud Manager は、 `1`から`52`までの値を返す場合があります。 `weeklySnapshotRetentionWeeks`を`0`に設定すると、このルールが無効になります。

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule" \
6      --data '
7        {
8          "fullIncrementalDayOfWeek":"TUESDAY",
9          "snapshotIntervalHours": 8,
10          "dailySnapshotRetentionDays": 15,
11          "monthlySnapshotRetentionMonths": 6
12        }'

応答例

応答ヘッダー

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

1 {
2   "clusterId" : "{CLUSTER-ID}",
3   "dailySnapshotRetentionDays" : 15,
4   "fullIncrementalDayOfWeek":"TUESDAY",
5   "groupId" : "{PROJECT-ID}",
6   "links" : [],
7   "monthlySnapshotRetentionMonths" : 6,
8   "pointInTimeWindowHours": 24,
9   "snapshotIntervalHours" : 8,
10   "snapshotRetentionDays" : 2,
11   "weeklySnapshotRetentionWeeks" : 4
12 }

戻る

スナップショットスケジュールを取得する

スナップショット

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule" \
6	--data '
7	{
8	"fullIncrementalDayOfWeek":"TUESDAY",
9	"snapshotIntervalHours": 8,
10	"dailySnapshotRetentionDays": 15,
11	"monthlySnapshotRetentionMonths": 6
12	}'

1	{
2	"clusterId" : "{CLUSTER-ID}",
3	"dailySnapshotRetentionDays" : 15,
4	"fullIncrementalDayOfWeek":"TUESDAY",
5	"groupId" : "{PROJECT-ID}",
6	"links" : [],
7	"monthlySnapshotRetentionMonths" : 6,
8	"pointInTimeWindowHours": 24,
9	"snapshotIntervalHours" : 8,
10	"snapshotRetentionDays" : 2,
11	"weeklySnapshotRetentionWeeks" : 4
12	}

注意