1개의 프로젝트에 대해 1개의 유지 관리 기간 업데이트
지정된 프로젝트의 유지 관리 기간을 업데이트합니다. 보안 패치와 같은 긴급 유지 관리 활동은 선택한 기간을 기다릴 수 없습니다. MongoDB Cloud는 필요할 때 이러한 유지 관리 활동을 시작합니다. 클러스터에 대한 유지 관리를 예약한 후에는 현재 유지 관리 작업이 완료될 때까지 유지 관리 기간을 변경할 수 없습니다. MongoDB Cloud가 수행하는 유지 관리 절차에는 유지 관리 기간 동안 복제본 세트당 하나 이상의 복제본 세트 선출이 필요합니다. 유지 관리는 항상 가급적 예정된 시간에 가깝게 시작하지만, 진행 중인 클러스터 업데이트 또는 예기치 않은 시스템 문제로 인해 시작 시간이 지연될 수 있습니다. 유지 관리 기간을 업데이트하면 이 프로젝트에 대한 모든 유지 관리 연기가 재설정됩니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할이 있어야 합니다.
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다.
body
필수 사항
지정된 프로젝트의 유지 관리 기간을 업데이트합니다.
-
MongoDB Cloud가 모든 유지 관리 기간을 활성화한 후 1주일 동안 연기해야 하는지 여부를 나타내는 플래그입니다.
-
유지 관리 기간이 시작되는 요일을 나타내는 1부터 시작하는 정수입니다.
1: 일요일.2: 월요일.3: 화요일.4: 수요일.5: 목요일.6: 금요일.7: 토요일.
최소값은
1, 최대값은7입니다. -
24시간제에 따라 유지 관리 기간이 시작되는 시간을 나타내는 0부터 시작하는 정수입니다. 자정에는
0을 사용하고 정오에는12을 사용합니다.최소값은
0, 최대값은23입니다. -
유지 관리가 시작되지 않는 창 을 정의합니다.
-
MongoDB Cloud가 이 요청을 수신하는 즉시 유지 관리 기간을 시작할지 여부를 나타내는 플래그입니다. 프로젝트에 대한 유지 관리 기간을 즉시 시작하려면 MongoDB Cloud에 유지 관리가 예약되어 있어야 하며, 유지 관리 기간을 설정해야 합니다. 이 플래그는 MongoDB Cloud가 유지보수를 완료한 후
false로 재설정됩니다.
atlas api maintenanceWindows updateGroupMaintenanceWindow --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231001001/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.UpdateGroupMaintenanceWindowApiParams{}
sdkResp, httpResp, err := client.MaintenanceWindowsApi.
UpdateGroupMaintenanceWindowWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-10-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-10-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \
-d '{ <Payload> }'{
"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"
}