1 つのプロジェクトに対する 1 つのメンテナンスウィンドウを更新
指定されたプロジェクトのメンテナンスウィンドウを更新します。セキュリティパッチのような至急の整備アクティビティは、選択したウィンドウを待つことはできません。MongoDB Cloud は必要に応じてこれらのメンテナンス アクティビティを開始します。クラスターのメンテナンスをスケジュールした後は、現在のメンテナンス作業が完了するまでメンテナンスウィンドウを変更できません。MongoDB Cloud が実行するメンテナンス手順では、レプリカセットごとに、メンテナンスウィンドウ中に少なくとも 1 回のレプリカセット選挙が必要です。メンテナンスは常に可能な限り予定時刻に近い時間に開始されますが、進行中のクラスターアップデートや予期しないシステム問題により、開始時間が遅れる可能性があります。メンテナンスウィンドウを更新すると、このプロジェクトのメンテナンスの延期がリセットされます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。
body
必須
指定されたプロジェクトのメンテナンスウィンドウを更新します。
-
MongoDB クラウドがすべてのメンテナンスウィンドウを有効にしてから 1 週間延期するかどうかを示すフラグ。
-
メンテナンスウィンドが開始される曜日を表す 1 から始まる整数。
1：日曜日。2：月曜日。3：火曜日。4：水曜日。5： 木曜日。6：金曜日。7：土曜日。
最小値は
1、最大値は7です。 -
メンテナンス ウィンドウが開始される時刻を 24 時間制で表す 0 から始まる整数。真夜中には
0、正午には12を使用します。最小値は
0、最大値は23です。 -
メンテナンスが開始されないウィンドウを定義します。
-
MongoDB Cloud がこのリクエストを受信するとすぐにメンテナンスウィンドウを開始するかどうかを示すフラグ。プロジェクトのメンテナンスウィンドウをすぐに開始するには、MongoDB Cloud でメンテナンスがスケジュールされており、メンテナンスウィンドウが設定されている必要があります。MongoDB Cloud のメンテナンスが完了すると、このフラグは
falseにリセットされます。
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/maintenanceWindow' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"autoDeferOnceEnabled":true,"dayOfWeek":42,"hourOfDay":42,"protectedHours":{"endHourOfDay":42,"startHourOfDay":42},"startASAP":true}'{
"autoDeferOnceEnabled": true,
"dayOfWeek": 42,
"hourOfDay": 42,
"protectedHours": {
"endHourOfDay": 42,
"startHourOfDay": 42
},
"startASAP": true
}{
"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"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}