注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
Resource
PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule
Request Parameters
リクエスト パス パラメーター
Parameter | タイプ | 必要性 | 説明 |
|---|---|---|---|
| string | 必須 | 更新対象のスナップショット スケジュールを持つクラスターを保持するプロジェクトの一意の識別子。 |
| string | 必須 | 更新対象のスナップショット スケジュールを持つクラスターの一意の識別子です。 |
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体をpretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
| 数値 | 任意 | 連続するクラスター チェックポイント間の分数。 これは、シャーディングされたクラスターにのみ適用されます。 この数値により、シャーディングされたクラスターのポイントインタイム復元の粒度が決まります。 |
| string | 任意 | このバックアップ構成が適用されるクラスターの一意の識別子。 |
| 数値 | 任意 | 日次スナップショットを保持する日数。指定できる値は、
|
| string | 任意 | MongoDB Ops Managerが完全なスナップショットを取得する曜日。 これにより、最新の完全なバックアップが保証されます。 MongoDB Ops Manager はデフォルト値をSUNDAYに設定します。 |
| string | 任意 | バックアップ構成を所有するプロジェクトの一意の識別子です。 |
| オブジェクト配列 | 任意 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての |
| 数値 | 任意 | 月次スナップショットを保持する月数。
|
| 数値 | 任意 | ポイントインタイム スナップショットを作成できる過去の時間数。 |
| 数値 | 任意 | 24 時間制でスナップショットをスケジュールする時刻。 |
| 数値 | 任意 | スナップショットをスケジュールする時間の 分。 |
| string | 任意 | Ops Manager ホストが存在する ISO-8601 タイムゾーン オフセット。夏時間に関する問題を回避するには、UTC を使用します。デフォルトは MongoDB Ops Managerは、保存する前に 例、 |
| 数値 | 任意 | スナップショット間の時間数。 |
| 数値 | 任意 | 最近のスナップショットを保持する日数。 |
| 数値 | 任意 | 週次スナップショットを保持する週数。
|
応答
名前 | タイプ | 説明 |
|---|---|---|
| 数値 | 連続するクラスター チェックポイント間の分数。 これは、シャーディングされたクラスターにのみ適用されます。 この数値により、シャーディングされたクラスターのポイントインタイム復元の粒度が決まります。 MongoDB Ops Manager は、 |
| string | このバックアップ構成が適用されるクラスターの一意の識別子。 |
| 数値 | 日次スナップショットを保持する日数。 MongoDB Ops Manager は、
|
| string | MongoDB Ops Managerが完全なスナップショットを取得する曜日。 これにより、最新の完全なバックアップが保証されます。 MongoDB Ops Manager はデフォルト値をSUNDAYに設定します。 |
| string | バックアップ構成を所有するプロジェクトの一意の識別子です。 |
| オブジェクト配列 | サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての |
| 数値 | Number of months to retain monthly snapshots. MongoDB Ops Manager は、
|
| 数値 | ポイントインタイム スナップショットを作成できる過去の時間数。 |
| 数値 | 24 時間制でスナップショットをスケジュールする時刻。 MongoDB Ops Manager は、 |
| 数値 | スナップショットをスケジュールする時間の 分。 MongoDB Ops Manager は、 |
| string | Ops Manager ホストが存在する ISO-8601 タイムゾーン オフセット。夏時間に関する問題を回避するには、UTC を使用します。デフォルトは MongoDB Ops Managerは、保存する前に 例、 |
| 数値 | スナップショット間の時間数。 MongoDB Ops Manager は、 |
| 数値 | 最近のスナップショットを保持する日数。 MongoDB Ops Manager は、 |
| 数値 | 週次スナップショットを保持する週数。 MongoDB Ops Manager は、
|
リクエストの例
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://<OpsManagerHost>:<Port>/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 }'
応答例
応答ヘッダー
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
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 }