注意
グループとプロジェクトは同義期間です。あなたの {PROJECT-ID} はグループ ID と同じです。既存のグループの場合、グループ/プロジェクトID は同じままです。このページでは、説明を参照するときに、より一般的な期間のグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
Resource
PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotScheduleRequest Parameters
リクエスト パス パラメーター
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 必須 | 更新対象のスナップショット スケジュールを持つクラスターを保持するプロジェクトの一意の識別子。 |
| string | 必須 | 更新対象のスナップショット スケジュールを持つクラスターの一意の識別子です。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| 数値 | 任意 | 連続するクラスター チェックポイント間の分数。 これは、シャーディングされたクラスターにのみ適用されます。 この数値により、シャーディングされたクラスターのポイントインタイム復元の粒度が決まります。 重要: MongoDB を実行するクラスターでは、4.0 以前の |
| string | 任意 | このバックアップ構成が適用されるクラスターの一意の識別子。 |
| 数値 | 任意 | 日次スナップショットを保持する日数。
|
| string | 任意 | Cloud Manager が完全なスナップショットを取得する曜日。 これにより、最新の完全なバックアップが保証されます。 Cloud Manager はデフォルト値をランダムな曜日に設定します。 |
| string | 任意 | バックアップ構成を所有するプロジェクトの一意の識別子です。 |
| オブジェクトの配列 | 任意 | サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての |
| 数値 | 任意 | 月次スナップショットを保持する月数。
|
| 数値 | 任意 | スナップショット間の時間数。 |
| 数値 | 任意 | 最近のスナップショットを保持する日数。 |
| 数値 | 任意 | 週次スナップショットを保持する週数。
|
応答
名前 | タイプ | 説明 |
|---|---|---|
| 数値 | 連続するクラスター チェックポイント間の分数。 これは、シャーディングされたクラスターにのみ適用されます。 この数値により、シャーディングされたクラスターのポイントインタイム復元の粒度が決まります。 Cloud Manager は、 重要: MongoDB を実行するクラスターでは、4.0 以前の |
| string | このバックアップ構成が適用されるクラスターの一意の識別子。 |
| 数値 | 日次スナップショットを保持する日数。 Cloud Manager は、
|
| string | Cloud Manager が完全なスナップショットを取得する曜日。 これにより、最新の完全なバックアップが保証されます。 Cloud Manager はデフォルト値をランダムな曜日に設定します。 |
| string | バックアップ構成を所有するプロジェクトの一意の識別子です。 |
| オブジェクトの配列 | サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての |
| 数値 | 月次スナップショットを保持する月数。 Cloud Manager は、
|
| 数値 | ポイントインタイム スナップショットを作成できる過去の時間数。 スナップショットの場合、この値を変更することはできません。 |
| 数値 | スナップショット間の時間数。 Cloud Manager は、 |
| 数値 | 最近のスナップショットを保持する日数。 Cloud Manager は、 |
| 数値 | 週次スナップショットを保持する週数。 Cloud Manager は、
|
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule" \ --data ' { "fullIncrementalDayOfWeek":"TUESDAY", "snapshotIntervalHours": 8, "dailySnapshotRetentionDays": 15, "monthlySnapshotRetentionMonths": 6 }'応答例
応答ヘッダー
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}レスポンス本体
{ "clusterId" : "{CLUSTER-ID}", "dailySnapshotRetentionDays" : 15, "fullIncrementalDayOfWeek":"TUESDAY", "groupId" : "{PROJECT-ID}", "links" : [], "monthlySnapshotRetentionMonths" : 6, "pointInTimeWindowHours": 24, "snapshotIntervalHours" : 8, "snapshotRetentionDays" : 2, "weeklySnapshotRetentionWeeks" : 4}