スナップショット スケジュールを取得する
項目一覧
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /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 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
|---|---|---|
clusterCheckpointIntervalMin | 数値 | 連続するクラスター チェックポイント間の分数。 これは、シャーディングされたクラスターにのみ適用されます。 この数値により、シャーディングされたクラスターのポイントインタイム復元の粒度が決まります。 MongoDB Ops Manager は、 15 、 30 、または60の値を返す場合があります。 |
clusterId | string | このバックアップ構成が適用されるクラスターの一意の識別子。 |
dailySnapshotRetentionDays | 数値 | 日次スナップショットを保持する日数。 MongoDB Ops Manager は、
|
fullIncrementalDayOfWeek | string | MongoDB Ops Managerが完全なスナップショットを取得する曜日。 これにより、最新の完全なバックアップが保証されます。 MongoDB Ops Manager はデフォルト値を SUNDAYに設定します。 |
groupId | string | バックアップ構成を所有するプロジェクトの一意の識別子です。 |
links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。 応答内のすべての |
monthlySnapshotRetentionMonths | 数値 | Number of months to retain monthly snapshots. MongoDB Ops Manager は、
|
pointInTimeWindowHours | 数値 | ポイントインタイム スナップショットを作成できる過去の時間数。 |
referenceHourOfDay | 数値 | 24 時間制でスナップショットをスケジュールする時刻。 MongoDB Ops Manager は、 0から23までの値を返す場合があります。 |
referenceMinuteOfHour | 数値 | スナップショットをスケジュールする時間の 分。 MongoDB Ops Manager は、 0から59までの値を返す場合があります。 |
referenceTimeZoneOffset | string | ISO-8601 タイムゾーン オフセット MongoDB Ops Manager ホストが存在する場所。夏時間に関する問題を回避するには、 UTCを使用します。 デフォルトは MongoDB Ops Managerは、保存する前に 例、 |
snapshotIntervalHours | 数値 | スナップショット間の時間数。 MongoDB Ops Manager は、 6 、 8 、 12 、または24の値を返す場合があります。 |
snapshotRetentionDays | 数値 | 最近のスナップショットを保持する日数。 MongoDB Ops Manager は、 2から5までの値を返す場合があります。 |
weeklySnapshotRetentionWeeks | 数値 | 週次スナップショットを保持する週数。 MongoDB Ops Manager は、
|
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule"
応答例
応答ヘッダー
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" : 7, 4 "groupId" : "{PROJECT-ID}", 5 "links" : [], 6 "monthlySnapshotRetentionMonths" : 13, 7 "pointInTimeWindowHours": 24, 8 "snapshotIntervalHours" : 6, 9 "snapshotRetentionDays" : 2, 10 "weeklySnapshotRetentionWeeks" : 4 11 }