1 つのプロジェクトの 1 つのメンテナンスウィンドウをリセット
指定されたプロジェクトのメンテナンスウィンドウをリセットします。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。セキュリティパッチのような至急の整備アクティビティは、選択したウィンドウを待つことはできません。MongoDB Cloud は必要に応じてこれらのメンテナンス アクティビティを開始します。クラスターのメンテナンスをスケジュールした後は、現在のメンテナンス作業が完了するまでメンテナンスウィンドウを変更できません。MongoDB Cloud が実行するメンテナンス手順では、レプリカセットごとに、メンテナンスウィンドウ中に少なくとも 1 回のレプリカセット選挙が必要です。メンテナンスは常に可能な限り予定時刻に近い時間に開始されますが、進行中のクラスターアップデートや予期しないシステム問題により、開始時間が遅れる可能性があります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト オーナー ロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。
DELETE /api/atlas/v2 /groups/{groupId}/maintenanceWindow
Atlas CLI
atlas api maintenanceWindows resetGroupMaintenanceWindow --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ResetGroupMaintenanceWindowApiParams{}
httpResp, err := client.MaintenanceWindowsApi.
ResetGroupMaintenanceWindowWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
-X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-05-30+json" \
-X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow"
応答の例(400)
{
"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"
}
応答の例(401)
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
応答の例(403)
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
応答の例(404)
{
"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"
}
応答の例(500)
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}