1개의 프로젝트에서 1개의 클러스터 업데이트
더 이상 사용되지 않습니다.
지정된 프로젝트의 클러스터 하나에 대한 세부 정보를 업데이트합니다. 클러스터에는 동일한 데이터 세트를 유지하는 호스팅 그룹이 포함되어 있습니다. 이 리소스는 비대칭 크기의 샤드로 클러스터를 업데이트할 수 있습니다. 클러스터의 종료 보호를 업데이트하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 다른 모든 업데이트의 경우, 요청하는 서비스 계정 또는 API 키에 프로젝트 클러스터 관리자 역할이 있어야 합니다. 일시 중지된 클러스터(paused : true)는 수정할 수 없습니다. paused : false로 설정하려면 이 엔드포인트를 호출해야 합니다. 이 엔드포인트가 paused : false로 응답하면 클러스터에 적용하려는 변경 사항을 포함하여 다시 호출할 수 있습니다. 이 기능은 서버리스 클러스터에서는 사용할 수 없습니다.
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다. -
클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
형식은
^[a-zA-Z0-9][a-zA-Z0-9-]*$패턴 과 일치해야 합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다. -
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은
false입니다.Prettyprint
body
필수 사항
지정된 프로젝트에서 업데이트할 클러스터.
-
리전 장애로 인해 프라이머리 토폴로지를 복구하기 위해 재구성이 필요한 경우 토폴로지 재구성과 함께 이 필드를 제출하여 새로운 리전 장애 방지 토폴로지를 요청하세요. 투표 선택 가능 노드 과반수의 장애가 발생한 상태에서 강제 재구성을 수행하면 복제된 쓰기(과반수의 커밋된 쓰기 포함)가 새 프라이머리 노드에 복제되지 않은 경우 데이터가 손실될 위험이 있습니다. MongoDB Atlas 문서에서 더 많은 정보를 참조할 수 있습니다. 이러한 위험을 수반하는 작업을 계속 진행하려면 acceptDataRisksAndForceReplicaSetReconfig를 현재 날짜로 설정하세요. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.
리전 장애 시 복제본 세트 재구성하기 -
고급 구성 세부 사항의 하위 집합을 구성하는 설정 그룹입니다.
-
클러스터를 확장할 수 있는 인스턴스 크기의 범위.
클러스터 자동 확장 -
클러스터가 백업을 수행할 수 있는지 여부를 나타내는 플래그.
true로 설정하면 클러스터가 백업을 수행할 수 있습니다. NVMe 클러스터의 경우 이 값을true로 설정해야 합니다. 백업은 전용 클러스터에는 클라우드 백업을, 테넌트 클러스터에는 공유 클러스터 백업을 사용합니다.false로 설정하면 클러스터에서 MongoDB Cloud 백업을 사용하지 않습니다. -
이 클러스터에 대한 Business Intelligence용 MongoDB Connector를 구성하는 데 필요한 설정입니다.
MongoDB Connector for Business Intelligence -
클러스터를 구성하는 노드의 구성.
값은
REPLICASET,SHARDED또는GEOSHARDED입니다. -
샤딩된 클러스터를 생성하거나 업데이트하기 위한 Config 서버 관리 모드입니다.
ATLAS_MANAGED로 구성된 경우, Atlas는 최적의 성능과 비용 절감을 위해 클러스터의 구성 서버 유형을 자동으로 전환할 수 있습니다.
FIXED_TO_DEDICATION으로 구성된 클러스터는 항상 전용 config 서버를 사용합니다.
값은
ATLAS_MANAGED또는FIXED_TO_DEDICATED입니다. 기본값은ATLAS_MANAGED입니다.MongoDB 샤딩된 클러스터 Config 서버 -
인스턴스 데이터 볼륨의 스토리지 용량은 기가바이트 단위로 표현됩니다. 용량을 추가하려면 이 숫자를 늘리세요.
이 값은 M0/M2/M5 클러스터에서 구성할 수 없습니다.
MongoDB Cloud는 replicationSpecs를 설정하는 경우 이 매개변수가 필요합니다.
디스크 크기를 최소값(10GB) 미만으로 지정하면 이 매개변수는 기본값인 최소 디스크 크기 값으로 설정됩니다.
스토리지 요금은 기본값을 선택하는지, 아니면 사용자 지정 값을 선택하는지에 따라 다르게 계산됩니다.
선택한 클러스터의 최대 RAM의 50배를 초과할 수 없습니다. 더 많은 저장 공간이 필요한 경우 클러스터를 더 높은 티어로 업그레이드하는 것이 좋습니다.
최소값은
10, 최대값은4096입니다. -
디스크 보온 모드 선택.
값은
FULLY_WARMED또는VISIBLE_EARLIER입니다. 기본값은FULLY_WARMED입니다.세컨더리 디스크 워밍(Warming) 영향 감소 -
클러스터에 추가 저장 시 암호화 계층을 제공하기 위해 고객 키를 관리하는 클라우드 서비스 공급자. 미활성화 암호화를 위한 고객 키 관리를 활성화하려면 클러스터 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 설정을
M10이상으로 지정하고"backupEnabled" : false또는 완전히 생략해야 합니다.값은
NONE,AWS,AZURE또는GCP입니다.고객 키 관리를 사용한 미사용 암호화 -
새 글로벌 클러스터를 생성할 때 샤딩 관리 모드를 구성하려면 이 필드를 설정합니다.
false로 설정하면 관리 모드가 Atlas 관리 샤딩으로 설정됩니다. 이 모드는 글로벌 클러스터의 샤딩을 완벽하게 관리하며 원활한 배포 환경을 제공하도록 구축되었습니다.
true로 설정하면 관리 모드가 자체 관리 샤딩으로 설정됩니다. 이 모드는 샤드 관리를 사용자에게 맡기며 유연한 고급 배포 환경을 제공하도록 설계되었습니다.
클러스터가 배포된 후에는 이 설정을 변경할 수 없습니다.
글로벌 클러스터 만들기 -
클러스터에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍 컬렉션. MongoDB Cloud 콘솔에는 레이블이 표시되지 않습니다.
클러스터 레이블은 더 이상 사용되지 않으며 향후 출시하다 에서 제거될 예정입니다. 대신 리소스 태그를 사용하는 것이 좋습니다.
이 MongoDB Cloud 구성 요소에 적용된 사람이 읽을 수 있는 레이블입니다.
Resource Tags -
클러스터에 대한 액세스 수준 및 만료 권한을 MongoDB 직원에게 부여했습니다.
-
클러스터의 MongoDB 주요 버전입니다.
생성 시: 사용 가능한 MongoDB 버전 중에서 선택하거나 현재 권장되는 기본값을 지정하지 않고 그대로 두어 MongoDB 클라우드 플랫폼에서 사용할 수 있습니다. 권장되는 버전은 최신 LTS(장기 지원) 버전입니다. 기본값은 전체 릴리스 주기 동안 가장 최근에 릴리스된 버전으로 보장되지 않습니다. 특정 프로젝트에서 사용할 수 있는 버전을 알아보려면 링크된 문서를 참조하거나 프로젝트 LTS 버전 엔드포인트에 대한 API 엔드포인트를 사용하세요.
업데이트 시: 한 번에 1개의 주요 버전만 버전을 증가시킵니다. 클러스터가 현재 MongoDB 버전보다 정확히 한 주요 버전 낮은 MongoDB 기능 호환성 버전에 고정되어 있는 경우, MongoDB 버전을 이전 주요 버전으로 다운그레이드할 수 있습니다.
Atlas에서 사용 가능한 MongoDB 버전 -
클러스터가 실행하는 MongoDB 버전.
형식은
([\d]+\.[\d]+\.[\d]+)패턴 과 일치해야 합니다. -
클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
형식은
^[a-zA-Z0-9][a-zA-Z0-9-]*$패턴 과 일치해야 합니다. -
샤딩된 클러스터에 배포할 샤드(최대 50개). 리소스는 복제본 세트의 경우
1를, 샤딩된 클러스터의 경우2이상의 값을 반환합니다. 반환된 값은 클러스터의 샤드 수와 같습니다.최소값은
1, 최대값은50입니다. 기본값은1입니다.샤딩 -
클러스터의 일시 중지 여부를 나타내는 플래그.
-
클러스터의 지속적인 클라우드 백업 사용 여부를 나타내는 플래그.
지속적인 클라우드 백업 -
M10 이상 클러스터에서 클라우드 백업을 수행할 수 있는지 여부를 나타내는 플래그입니다.
true로 설정하면 클러스터가 백업을 수행할 수 있습니다. 이 리소스와 BackupEnabled를false로 설정하면 클러스터에서 MongoDB 클라우드 백업을 사용하지 않습니다. -
이 필드를 설정하여 클러스터의 복제본 세트 스케일링 모드를 구성합니다.
기본적으로 Atlas는 WORKLOAD_TYPE에 따라 확장됩니다. 이 모드를 사용하면 Atlas가 운영 노드와 함께 분석 노드를 병렬 확장할 수 있습니다.
SEQUENTIAL로 구성된 경우 Atlas는 모든 노드를 순차적으로 확장합니다. 이 모드는 안정된 상태의 워크로드 및 지연 시간에 민감한 세컨더리 읽기를 수행하는 애플리케이션을 대상으로 합니다.
NODE_TYPE으로 구성하면 Atlas는 읽기 전용 및 분석 노드와 병렬로 선택 가능한 노드를 확장합니다. 이 모드는 자주 그리고 신속한 클러스터 계층 확장이 필요한 대규모 동적 워크로드에 적합합니다. 이는 가장 빠른 확장 전략이지만 광범위한 세컨더리 읽기 작업을 수행할 때 워크로드 지연에 영향을 미칠 수 있습니다.
값은
SEQUENTIAL,WORKLOAD_TYPE또는NODE_TYPE입니다. 기본값은WORKLOAD_TYPE입니다.복제본 세트 확장 모드 수정 -
복제본 세트에 속한 멤버 수. 각 구성원은 데이터베이스 사본을 유지하여 고가용성과 데이터 중복성을 제공합니다. 대신 replicationSpecs을 사용하세요.
값은
3,5또는7입니다. 기본값은3입니다. -
MongoDB Cloud가 클러스터 노드를 프로비저닝하는 물리적 위치.
-
클러스터 리전을 구성하는 설정 목록.
- 글로벌 클러스터의 경우 배열의 각 객체는 MongoDB Cloud가 클러스터 노드를 배포하는 하나의 영역을 나타냅니다.
- 글로벌이 아닌 샤딩된 클러스터 및 복제본 세트의 경우 MongoDB Cloud의 클러스터 노드 배포 위치를 나타내는 객체가 하나 포함됩니다.
-
MongoDB Atlas cluster 사용하는 루트 인증 기관. MongoDB Cloud는 Internet Security Research Group을 지원합니다.
값은
ISRGROOTX1입니다. 기본값은ISRGROOTX1입니다. -
클러스터의 종료 보호 활성화 여부를 나타내는 플래그.
true로 설정하면 MongoDB Cloud가 클러스터를 삭제하지 않습니다.false로 설정하면 MongoDB Cloud가 클러스터를 삭제합니다.기본값은
false입니다. -
클러스터가 MongoDB 버전을 유지 관리하는 방법입니다. 값이
CONTINUOUS인 경우 mongoDBMajorVersion을 지정하지 않아야 합니다.값은
LTS또는CONTINUOUS입니다. 기본값은LTS입니다.
atlas api clusters updateGroupCluster --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/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.UpdateGroupClusterApiParams{}
sdkResp, httpResp, err := client.ClustersApi.
UpdateGroupClusterWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \
-d '{ <Payload> }'{
"acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"predictiveEnabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskSizeGB": 42.0,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [
{
"key": "string",
"value": "string"
}
],
"mongoDBEmployeeAccessGrant": {
"expirationTime": "2025-05-04T09:42:00Z",
"grantType": "CLUSTER_DATABASE_LOGS"
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "AWS",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}{
"acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"predictiveEnabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {
"awsPrivateLink": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"awsPrivateLinkSrv": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"private": "string",
"privateEndpoint": [
{
"connectionString": "string",
"endpoints": [
{
"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2025-05-04T09:42:00Z",
"diskSizeGB": 42.0,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2025-05-04T09:42:00Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [
{
"key": "string",
"value": "string"
}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {
"expirationTime": "2025-05-04T09:42:00Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2025-05-04T09:42:00Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "AWS",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}{
"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": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}