1개의 프로젝트에서 1개의 클러스터 업데이트 더 이상 사용되지 않습니다.

패치 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}
서비스 계정 DigestAuth

지정된 프로젝트 에 있는 한 클러스터 의 세부 정보를 업데이트합니다. 클러스터에는 동일한 데이터 세트 유지하는 호스트 그룹 포함되어 있습니다. 이 리소스 비대칭 크기의 샤드로 클러스터를 업데이트 할 수 있습니다. 클러스터의 종료 보호 기능을 업데이트 하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할 있어야 합니다. 다른 모든 업데이트의 경우 요청하는 서비스 계정 또는 API 키에 프로젝트 클러스터 관리자 역할 있어야 합니다. 일시 중지된 클러스터 (paused : true)는 수정할 수 없습니다. paused : false을(를) 설정하다 하려면 이 엔드포인트를 호출해야 합니다. 이 엔드포인트가 paused : false로 응답하면 클러스터 에 적용하려는 변경 사항을 적용하여 다시 호출할 수 있습니다. 이 기능 서버리스 클러스터에서는 사용할 수 없습니다. 더 이상 사용되지 않는 버전: v2-{2023-01-01}

경로 매개변수

  • groupId 문자열 필수 사항

    프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.

    참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • clusterName 문자열 필수 사항

    클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

    형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

쿼리 매개변수

  • envelope 부울

    애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

    기본값은 false 입니다.

  • pretty 부울

    응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

    기본값은 false 입니다.

    Prettyprint
application/vnd.atlas.2023-02-01+json

body 필수 사항

지정된 프로젝트에서 업데이트할 클러스터.

  • acceptDataRisksAndForceReplicaSetReconfig 문자열(날짜-시간)

    리전 장애로 인해 프라이머리 토폴로지를 복구하기 위해 재구성이 필요한 경우 토폴로지 재구성과 함께 이 필드를 제출하여 새로운 리전 장애 방지 토폴로지를 요청하세요. 투표 선택 가능 노드 과반수의 장애가 발생한 상태에서 강제 재구성을 수행하면 복제된 쓰기(과반수의 커밋된 쓰기 포함)가 새 프라이머리 노드에 복제되지 않은 경우 데이터가 손실될 위험이 있습니다. MongoDB Atlas 문서에서 더 많은 정보를 참조할 수 있습니다. 이러한 위험을 수반하는 작업을 계속 진행하려면 acceptDataRisksAndForceReplicaSetReconfig를 현재 날짜로 설정하세요. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

    리전 장애 시 복제본 세트 재구성하기
  • 고급 구성 객체

    고급 구성 세부 사항의 하위 집합을 구성하는 설정 그룹입니다.

    advancedConfiguration 속성 숨기기 advancedConfiguration 속성 표시 객체
    • customOpensslCipherConfigTls12 array[string]

      TLS 1.2에 대한 사용자 지정 OpenSSL 암호 제품군 목록입니다. 이 필드 tlsCipherConfigMode 가 CUSTOM로 설정하다 경우에만 유효합니다.

      값은 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 또는 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256입니다.

    • minimumEnabledTlsProtocol 문자열

      클러스터가 수신 연결 시 허용하는 최소 TLS(전송 계층 보안) 버전. TLS 1.0 또는 1.1을 사용하는 클러스터에서는 TLS 1.2를 최소 TLS 프로토콜 버전으로 설정하는 것이 좋습니다.

      값은 TLS1_0, TLS1_1 또는 TLS1_2입니다.

      이 옵션은 `netssldisabledProtocols` `mongod` 구성 파일 옵션에 해당합니다.
    • tlsCipherConfigMode 문자열

      TLS 암호 제품군 구성 모드. 기본값 모드 기본값 암호 제품군을 사용합니다. 사용자 지정 모드 사용하면 TLS 1.2 및 TLS 1.3 모두에 대한 사용자 지정 암호 제품군을 지정할 수 있습니다.

      값은 CUSTOM 또는 DEFAULT입니다.

  • backupEnabled 부울

    클러스터 백업을 수행할 수 있는지 여부를 나타내는 플래그입니다. true로 설정하다 클러스터 백업을 수행할 수 있습니다. NVMe 클러스터의 경우 이 값을 true 로 설정하다 해야 합니다. 백업은 전용 클러스터에는 클라우드 백업 을 사용하고 테넌트 클러스터에는 공유 클러스터 백업 을 사용합니다. false로 설정하다 클러스터 백업을 사용하지 않습니다.

    기본값은 false 입니다.

  • BI 커넥터 객체

    이 클러스터에 대한 Business Intelligence용 MongoDB Connector를 구성하는 데 필요한 설정입니다.

    MongoDB Connector for Business Intelligence
    바이커넥터 속성 숨기기 바이커넥터 속성 표시 객체
    • 활성화됨 부울

      지정된 클러스터 에서 MongoDB Connector for Business Intelligence가 활성화되어 있는지 여부를 나타내는 플래그입니다.

    • 읽기 설정 문자열

      MongoDB Cloud의 MongoDB Connector for Business Intelligence용으로 지정된 데이터 소스 노드 . MongoDB Cloud의 MongoDB Connector for Business Intelligence는 읽기 설정에 따라 프라이머리, 세컨더리 또는 분석 노드 에서 데이터를 읽습니다. 기본값은 ANALYTICS 노드 또는 ANALYTICS 노드가 없는 경우 SECONDARY 입니다.

      값은 PRIMARY, SECONDARY 또는 ANALYTICS입니다.

      BI Connector 에 대한 읽기 기본 설정
  • clusterType 문자열

    클러스터를 구성하는 노드의 구성.

    값은 REPLICASET, SHARDED 또는 GEOSHARDED입니다.

  • configServerManagementMode 문자열

    샤딩된 클러스터를 생성하거나 업데이트하기 위한 Config 서버 관리 모드입니다.

    ATLAS_MANAGED로 구성된 경우, Atlas는 최적의 성능과 비용 절감을 위해 클러스터의 구성 서버 유형을 자동으로 전환할 수 있습니다.

    FIXED_TO_DEDICATION으로 구성된 클러스터는 항상 전용 config 서버를 사용합니다.

    값은 ATLAS_MANAGED 또는 FIXED_TO_DEDICATED입니다. 기본값은 ATLAS_MANAGED입니다.

    MongoDB 샤딩된 클러스터 Config 서버
  • diskSizeGB number(double)

    인스턴스 데이터 볼륨의 스토리지 용량은 기가바이트 단위로 표현됩니다. 용량을 추가하려면 이 숫자를 늘리세요.

    이 값은 M0/M2/M5 클러스터에서 구성할 수 없습니다.

    MongoDB Cloud는 replicationSpecs를 설정하는 경우 이 매개변수가 필요합니다.

    디스크 크기를 최소값(10GB) 미만으로 지정하면 이 매개변수는 기본값인 최소 디스크 크기 값으로 설정됩니다.

    스토리지 요금은 기본값을 선택하는지, 아니면 사용자 지정 값을 선택하는지에 따라 다르게 계산됩니다.

    선택한 클러스터의 최대 RAM의 50배를 초과할 수 없습니다. 더 많은 저장 공간이 필요한 경우 클러스터를 더 높은 티어로 업그레이드하는 것이 좋습니다.

    스토리지 사용자 지정
  • diskWarmingMode 문자열

    디스크 보온 모드 선택.

    값은 FULLY_WARMED 또는 VISIBLE_EARLIER입니다. 기본값은 FULLY_WARMED입니다.

    세컨더리 디스크 워밍(Warming) 영향 감소
  • encryptionAtRestProvider 문자열

    클러스터에 추가 저장 시 암호화 계층을 제공하기 위해 고객 키를 관리하는 클라우드 서비스 공급자. 미활성화 암호화를 위한 고객 키 관리를 활성화하려면 클러스터 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 설정을 M10 이상으로 지정하고 "backupEnabled" : false 또는 완전히 생략해야 합니다.

    값은 NONE, AWS, AZURE 또는 GCP입니다.

    고객 키 관리를 사용한 미사용 암호화
  • globalClusterSelfManagedSharding 부울

    새 글로벌 클러스터를 생성할 때 샤딩 관리 모드를 구성하려면 이 필드를 설정합니다.

    false로 설정하면 관리 모드가 Atlas 관리 샤딩으로 설정됩니다. 이 모드는 글로벌 클러스터의 샤딩을 완벽하게 관리하며 원활한 배포 환경을 제공하도록 구축되었습니다.

    true로 설정하면 관리 모드가 자체 관리 샤딩으로 설정됩니다. 이 모드는 샤드 관리를 사용자에게 맡기며 유연한 고급 배포 환경을 제공하도록 설계되었습니다.

    클러스터가 배포된 후에는 이 설정을 변경할 수 없습니다.

    글로벌 클러스터 만들기
  • labels 배열[객체] 더 이상 사용되지 않습니다.

    클러스터에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍 컬렉션. MongoDB Cloud 콘솔에는 레이블이 표시되지 않습니다.

    클러스터 레이블은 더 이상 사용되지 않으며 향후 릴리스에서 제거될 예정입니다. 대신 리소스 태그를 사용할 것을 적극 권장합니다.

    이 MongoDB Cloud 구성 요소에 적용된 사람이 읽을 수 있는 레이블입니다.

    Resource Tags
    레이블 속성 숨기기 레이블 속성 표시 객체
    • 키 문자열

      이 구성 요소에 태그를 지정하다 하고 분류하는 데 적용되는 키입니다.

      최소 길이는 1, 최대 길이는 255입니다.

    • value 문자열

      이 구성 요소에 태그를 지정하다 하고 분류하는 데 적용된 키에 설정하다 값입니다.

      최소 길이는 1, 최대 길이는 255입니다.

  • mongoDBEmployeeAccessGrant 객체

    클러스터에 대한 액세스 수준 및 만료 권한을 MongoDB 직원에게 부여했습니다.

    mongoDBEmployeeAccessGrant 속성 숨기기 mongoDBEmployeeAccessGrant 속성 표시 객체
    • expireTime 문자열(날짜-시간) 필수 사항

      직원에게 부여된 액세스의 만료일입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

    • grantType 문자열 필수 사항

      MongoDB 직원에게 부여할 액세스 수준입니다.

      값은 CLUSTER_DATABASE_LOGS, CLUSTER_INFRASTRUCTURE 또는 CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA입니다.

  • mongoDBMajorVersion 문자열

    클러스터의 MongoDB 주요 버전입니다.

    생성 시: 사용 가능한 MongoDB 버전 중에서 선택하거나 현재 권장되는 기본값을 지정하지 않고 그대로 두어 MongoDB 클라우드 플랫폼에서 사용할 수 있습니다. 권장되는 버전은 최신 LTS(장기 지원) 버전입니다. 기본값은 전체 릴리스 주기 동안 가장 최근에 릴리스된 버전으로 보장되지 않습니다. 특정 프로젝트에서 사용할 수 있는 버전을 알아보려면 링크된 문서를 참조하거나 프로젝트 LTS 버전 엔드포인트에 대한 API 엔드포인트를 사용하세요.

    업데이트 시: 한 번에 1개의 주요 버전만 버전을 증가시킵니다. 클러스터가 현재 MongoDB 버전보다 정확히 한 주요 버전 낮은 MongoDB 기능 호환성 버전에 고정되어 있는 경우, MongoDB 버전을 이전 주요 버전으로 다운그레이드할 수 있습니다.

    Atlas에서 사용 가능한 MongoDB 버전
  • 이름 문자열

    고급 클러스터를 식별하는 인간 판독 가능 레이블.

    형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

  • paused 부울

    클러스터의 일시 중지 여부를 나타내는 플래그.

  • pitEnabled 부울

    클러스터의 지속적인 클라우드 백업 사용 여부를 나타내는 플래그.

    지속적인 클라우드 백업
  • replicaSetScalingStrategy 문자열

    이 필드를 설정하여 클러스터의 복제본 세트 스케일링 모드를 구성합니다.

    기본적으로 Atlas는 WORKLOAD_TYPE에 따라 확장됩니다. 이 모드를 사용하면 Atlas가 운영 노드와 함께 분석 노드를 병렬 확장할 수 있습니다.

    SEQUENTIAL로 구성된 경우 Atlas는 모든 노드를 순차적으로 확장합니다. 이 모드는 안정된 상태의 워크로드 및 지연 시간에 민감한 세컨더리 읽기를 수행하는 애플리케이션을 대상으로 합니다.

    NODE_TYPE으로 구성하면 Atlas는 읽기 전용 및 분석 노드와 병렬로 선택 가능한 노드를 확장합니다. 이 모드는 자주 그리고 신속한 클러스터 계층 확장이 필요한 대규모 동적 워크로드에 적합합니다. 이는 가장 빠른 확장 전략이지만 광범위한 세컨더리 읽기 작업을 수행할 때 워크로드 지연에 영향을 미칠 수 있습니다.

    값은 SEQUENTIAL, WORKLOAD_TYPE 또는 NODE_TYPE입니다. 기본값은 WORKLOAD_TYPE입니다.

    복제본 세트 확장 모드 수정
  • replicationSpecs 배열[객체]

    클러스터 리전을 구성하는 설정 목록. 글로벌 클러스터의 경우 배열의 각 객체는 클러스터 노드 배포 영역을 나타냅니다. 글로벌이 아닌 샤딩된 클러스터 및 복제본 세트의 경우 이 배열에는 클러스터 노드 배포 위치를 나타내는 객체가 하나 포함됩니다.

    MongoDB Cloud가 지정된 MongoDB database 에 데이터를 복제하는 방법을 설명하는 세부 정보입니다.

    replicationSpecs 속성 숨기기 replicationSpecs 속성 표시 객체
    • numShards integer(int32)

      지정된 각 구역 에 배포 할 샤드 수를 지정하는 양의 정수입니다. 이 값을 1 로 설정하다 clusterType 이 SHARDED인 경우 MongoDB Cloud는 단일 샤딩된 클러스터 배포합니다. 프로덕션 환경에서는 단일 샤드 로 샤딩된 클러스터 생성하지 마세요. 단일 샤드 샤딩된 클러스터는 다중 샤드 구성과 동일한 이점을 제공하지 않습니다.

      복제본 세트 샤딩된 클러스터 로 업그레이드하는 경우 동일한 업데이트 요청 에서 샤드 수를 늘릴 수 없습니다. 샤드를 추가하기 전에 클러스터 샤딩된 로의 업그레이드를 완료하고 모든 애플리케이션 클라이언트를 MongoDB 라우터에 다시 연결할 때까지 기다려야 합니다. 그렇지 않으면 MongoDB Cloud가 샤드 전체에 데이터를 배포하기 시작할 때 데이터가 일관되지 않을 수 있습니다.

      최소값은 1입니다.

    • regionConfigs 배열[객체]

      특정 리전 에 설정하다 노드의 하드웨어 사양입니다. 각 regionConfigs 객체 replicationSpec 내에서 리전 및 cloud 제공자 에 따라 고유해야 합니다.각 regionConfigs 객체 선거에서 리전의 우선 순위 와 MongoDB Cloud가 해당 리전 에 배포하는 MongoDB 노드의 수 및 유형을 설명합니다. 각 regionConfigs 객체 analyzeSpecs 객체,ectableSpecs 객체 또는 readOnlySpecs 객체 가 있어야 합니다. 테넌트 클러스터에는 eltableSpecs만 필요합니다. 전용 클러스터는 이러한 사양 중 하나를 지정할 수 있지만 replicationSpec 내에 ectableSpecs 객체 하나 이상 있어야 합니다. 모든 hardware 사양은 동일한 인스턴스 크기를 사용해야 합니다.

      예시:

      "replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize" : "M30" 설정하다 설정하다 경우 "replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" :"M30"if you have electable nodes and"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize" : 읽기 전용 노드가 있는 경우 "M30".

      다음 중 하나입니다.
      AWS 객체 AZURE 객체 GCP 객체 TENANT 객체
    • zoneName 문자열

      글로벌 클러스터의 구역 식별하는 사람이 읽을 수 있는 레이블입니다. "clusterType" : "GEOSHARDED"인 경우에만 이 값을 제공하세요.

  • rootCertType 문자열

    MongoDB Atlas cluster 사용하는 루트 인증 기관. MongoDB Cloud는 Internet Security Research 그룹을 지원합니다.

    값은 ISRGROOTX1입니다. 기본값은 ISRGROOTX1입니다.

  • tags 배열[객체]

    클러스터에 태그를 지정하고 분류하기 위한 1~255자 길이의 키-값 쌍이 포함된 목록입니다.

    MongoDB Cloud 조직, 프로젝트 또는 클러스터 태그를 지정하고 분류하는 키-값 쌍입니다. 예시: environment : production.

    Resource Tags
    Hide tags attributes 태그 속성 표시 객체
    • 키 문자열 필수 사항

      태그 세트를 정의하는 상수입니다. 예를 들어 environment : production 태그의 environment 입니다.

      최소 길이는 1, 최대 길이는 255입니다.

    • value 문자열 필수 사항

      태그 세트에 속하는 변수입니다. 예를 들어 environment : production 태그의 production 입니다.

      최소 길이는 1, 최대 길이는 255입니다.

  • terminationProtectionEnabled 부울

    클러스터의 종료 보호 활성화 여부를 나타내는 플래그. true로 설정하면 MongoDB Cloud가 클러스터를 삭제하지 않습니다. false로 설정하면 MongoDB Cloud가 클러스터를 삭제합니다.

    기본값은 false 입니다.

  • versionReleaseSystem 문자열

    클러스터가 MongoDB 버전을 유지 관리하는 방법입니다. 값이 CONTINUOUS인 경우 mongoDBMajorVersion을 지정하지 않아야 합니다.

    값은 LTS 또는 CONTINUOUS입니다. 기본값은 LTS입니다.

응답

  • 200 application/vnd.atlas.2023-02-01+json

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • acceptDataRisksAndForceReplicaSetReconfig 문자열(날짜-시간)

      리전 장애로 인해 프라이머리 토폴로지를 복구하기 위해 재구성이 필요한 경우 토폴로지 재구성과 함께 이 필드를 제출하여 새로운 리전 장애 방지 토폴로지를 요청하세요. 투표 선택 가능 노드 과반수의 장애가 발생한 상태에서 강제 재구성을 수행하면 복제된 쓰기(과반수의 커밋된 쓰기 포함)가 새 프라이머리 노드에 복제되지 않은 경우 데이터가 손실될 위험이 있습니다. MongoDB Atlas 문서에서 더 많은 정보를 참조할 수 있습니다. 이러한 위험을 수반하는 작업을 계속 진행하려면 acceptDataRisksAndForceReplicaSetReconfig를 현재 날짜로 설정하세요. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      리전 장애 시 복제본 세트 재구성하기
    • 고급 구성 객체

      고급 구성 세부 사항의 하위 집합을 구성하는 설정 그룹입니다.

      advancedConfiguration 속성 숨기기 advancedConfiguration 속성 표시 객체
      • customOpensslCipherConfigTls12 array[string]

        TLS 1.2에 대한 사용자 지정 OpenSSL 암호 제품군 목록입니다. 이 필드 tlsCipherConfigMode 가 CUSTOM로 설정하다 경우에만 유효합니다.

        값은 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 또는 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256입니다.

      • minimumEnabledTlsProtocol 문자열

        클러스터가 수신 연결 시 허용하는 최소 TLS(전송 계층 보안) 버전. TLS 1.0 또는 1.1을 사용하는 클러스터에서는 TLS 1.2를 최소 TLS 프로토콜 버전으로 설정하는 것이 좋습니다.

        값은 TLS1_0, TLS1_1 또는 TLS1_2입니다.

        이 옵션은 `netssldisabledProtocols` `mongod` 구성 파일 옵션에 해당합니다.
      • tlsCipherConfigMode 문자열

        TLS 암호 제품군 구성 모드. 기본값 모드 기본값 암호 제품군을 사용합니다. 사용자 지정 모드 사용하면 TLS 1.2 및 TLS 1.3 모두에 대한 사용자 지정 암호 제품군을 지정할 수 있습니다.

        값은 CUSTOM 또는 DEFAULT입니다.

    • backupEnabled 부울

      클러스터 백업을 수행할 수 있는지 여부를 나타내는 플래그입니다. true로 설정하다 클러스터 백업을 수행할 수 있습니다. NVMe 클러스터의 경우 이 값을 true 로 설정하다 해야 합니다. 백업은 전용 클러스터에는 클라우드 백업 을 사용하고 테넌트 클러스터에는 공유 클러스터 백업 을 사용합니다. false로 설정하다 클러스터 백업을 사용하지 않습니다.

      기본값은 false 입니다.

    • BI 커넥터 객체

      이 클러스터에 대한 Business Intelligence용 MongoDB Connector를 구성하는 데 필요한 설정입니다.

      MongoDB Connector for Business Intelligence
      바이커넥터 속성 숨기기 바이커넥터 속성 표시 객체
      • 활성화됨 부울

        지정된 클러스터 에서 MongoDB Connector for Business Intelligence가 활성화되어 있는지 여부를 나타내는 플래그입니다.

      • 읽기 설정 문자열

        MongoDB Cloud의 MongoDB Connector for Business Intelligence용으로 지정된 데이터 소스 노드 . MongoDB Cloud의 MongoDB Connector for Business Intelligence는 읽기 설정에 따라 프라이머리, 세컨더리 또는 분석 노드 에서 데이터를 읽습니다. 기본값은 ANALYTICS 노드 또는 ANALYTICS 노드가 없는 경우 SECONDARY 입니다.

        값은 PRIMARY, SECONDARY 또는 ANALYTICS입니다.

        BI Connector 에 대한 읽기 기본 설정
    • clusterType 문자열

      클러스터를 구성하는 노드의 구성.

      값은 REPLICASET, SHARDED 또는 GEOSHARDED입니다.

    • configServerManagementMode 문자열

      샤딩된 클러스터를 생성하거나 업데이트하기 위한 Config 서버 관리 모드입니다.

      ATLAS_MANAGED로 구성된 경우, Atlas는 최적의 성능과 비용 절감을 위해 클러스터의 구성 서버 유형을 자동으로 전환할 수 있습니다.

      FIXED_TO_DEDICATION으로 구성된 클러스터는 항상 전용 config 서버를 사용합니다.

      값은 ATLAS_MANAGED 또는 FIXED_TO_DEDICATED입니다. 기본값은 ATLAS_MANAGED입니다.

      MongoDB 샤딩된 클러스터 Config 서버
    • 서버 유형 구성 문자열

      샤드 클러스터의 config 서버 유형을 설명합니다.

      값은 DEDICATED 또는 EMBEDDED입니다.

      MongoDB 샤딩된 클러스터 Config 서버
    • 연결 문자열 객체

      MongoDB 데이터베이스를 가리키는 컬렉션입니다.

      연결 문자열 URI 형식
      connectionStrings 속성 숨기기 connectionStrings 속성 표시 객체
      • awsPrivateLink 객체

        Amazon Web Services (AWS) PrivateLink와 함께 AWS 호스팅 클러스터를 사용하는 비공개 엔드포인트 인식 연결 문자열입니다. 각 키는 AWS( Amazon Web Services ) 인터페이스 엔드포인트 식별합니다. 각 값은 키가 명명하는 인터페이스 엔드포인트 통해 MongoDB Cloud에 연결하는 데 사용하는 관련 mongodb:// 연결 문자열 식별합니다.

        네트워크 피어링 연결
        awsPrivateLink 속성 숨기기 awsPrivateLink 속성 표시 객체
        • * 문자열 additionalProperties

          Amazon Web Services (AWS) PrivateLink와 함께 AWS 호스팅 클러스터를 사용하는 비공개 엔드포인트 인식 연결 문자열입니다. 각 키는 AWS( Amazon Web Services ) 인터페이스 엔드포인트 식별합니다. 각 값은 키가 명명하는 인터페이스 엔드포인트 통해 MongoDB Cloud에 연결하는 데 사용하는 관련 mongodb:// 연결 문자열 식별합니다.

          네트워크 피어링 연결
      • awsPrivateLinkSrv 객체

        Amazon Web Services (AWS) PrivateLink와 함께 AWS 호스팅 클러스터를 사용하는 비공개 엔드포인트 인식 연결 문자열입니다. 각 키는 AWS( Amazon Web Services ) 인터페이스 엔드포인트 식별합니다. 각 값은 키가 명명하는 인터페이스 엔드포인트 통해 Atlas 에 연결하는 데 사용하는 관련 mongodb:// 연결 문자열 식별합니다. 클러스터 최적화된 연결 문자열 사용하는 경우 awsPrivateLinkSrv 에는 최적화된 연결 문자열 포함됩니다. 클러스터 에 최적화되지 않은(레거시) 연결 문자열 있는 경우, 최적화된 연결 문자열 있더라도 awsPrivateLinkSrv 에는 최적화되지 않은 연결 문자열 포함됩니다.

        네트워크 피어링 연결
        awsPrivateLinkSrv 속성 숨기기 awsPrivateLinkSrv 속성 표시 객체
        • * 문자열 additionalProperties

          Amazon Web Services (AWS) PrivateLink와 함께 AWS 호스팅 클러스터를 사용하는 비공개 엔드포인트 인식 연결 문자열입니다. 각 키는 AWS( Amazon Web Services ) 인터페이스 엔드포인트 식별합니다. 각 값은 키가 명명하는 인터페이스 엔드포인트 통해 Atlas 에 연결하는 데 사용하는 관련 mongodb:// 연결 문자열 식별합니다. 클러스터 최적화된 연결 문자열 사용하는 경우 awsPrivateLinkSrv 에는 최적화된 연결 문자열 포함됩니다. 클러스터 에 최적화되지 않은(레거시) 연결 문자열 있는 경우, 최적화된 연결 문자열 있더라도 awsPrivateLinkSrv 에는 최적화되지 않은 연결 문자열 포함됩니다.

          네트워크 피어링 연결
      • 비공개 문자열

        이 클러스터 에 연결하도록 구성한 각 인터페이스 가상 사설 클라우드( VPC ) 엔드포인트에 대한 네트워크 피어링 연결 문자열입니다. 이 연결 문자열 mongodb+srv:// 프로토콜 사용합니다. 누군가 이 클러스터 에 대한 네트워크 피어링 연결 생성하면 리소스 이 매개변수를 반환합니다. 이 프로토콜 애플리케이션 에 DNS(Domain Name System)에서 호스팅하다 시드 목록 찾도록 지시합니다. 이 목록은 클러스터 의 노드와 동기화됩니다. 연결 문자열 이 URI(Uniform Resource Identifier) 형식을 사용하는 경우 노드가 변경되더라도 시드 목록 추가하거나 URI를 변경할 필요가 없습니다. 운전자 에서 지원하는 경우 이 URI 형식을 사용하세요. 그렇지 않은 경우 connectionStrings.private를 사용하세요. Amazon Web Services (AWS) 클러스터의 경우, 이 리소스 사용자 지정 DNS를 활성화 경우에만 이 매개변수를 반환합니다.

        네트워크 피어링 연결
      • privateEndpoint 배열[객체]

        비공개 엔드포인트를 통해 이 클러스터 에 연결하는 데 사용할 수 있는 비공개 엔드포인트 인식 연결 문자열의 목록입니다. 이 매개변수는 이 클러스터의 노드를 배포한 모든 리전에 비공개 엔드포인트를 배포한 경우에만 반환됩니다.

        비공개 엔드포인트를 통해 이 클러스터 에 연결하는 데 사용할 수 있는 비공개 엔드포인트 인식 연결 문자열 .

        privateEndpoint 속성 숨기기 privateEndpoint 속성 표시 객체
        • ConnectionString 문자열

          mongodb:// 프로토콜 사용하여 비공개 엔드포인트를 통해 MongoDB Cloud에 연결하는 비공개 엔드포인트 인식 연결 문자열 .

        • 엔드포인트 배열[객체]

          connectionStrings.privateEndpoint[n].connectionString 또는 connectionStrings.privateEndpoint[n].srvConnectionString 사용할 때 MongoDB Cloud에 연결하는 데 사용하는 비공개 엔드포인트 포함된 목록입니다.

          이 클러스터 에 배포된 비공개 엔드포인트의 세부 정보입니다.

          엔드포인트 속성 숨기기 엔드포인트 속성 표시 객체
          • endpointId 문자열

            cloud 제공자 비공개 엔드포인트를 식별하는 데 사용하는 고유 문자열입니다.

          • providerName 문자열

            MongoDB Cloud가 비공개 엔드포인트를 배포하는 클라우드 제공자 .

            값은 AWS, AZURE 또는 GCP입니다.

          • 리전 문자열

            비공개 엔드포인트가 배포되는 리전입니다.

        • srvConnectionString 문자열

          mongodb+srv:// 프로토콜 사용하여 비공개 엔드포인트를 통해 MongoDB Cloud에 연결하는 비공개 엔드포인트 인식 연결 문자열 . mongodb+srv 프로토콜 운전자 DNS(Domain Name System)에서 호스트의 시드 목록 찾도록 지시합니다. 이 목록은 클러스터 의 노드와 동기화됩니다. 연결 문자열 이 URI(Uniform Resource Identifier) 형식을 사용하는 경우 노드가 변경되더라도 시드 목록 추가하거나 URI(Uniform Resource Identifier)를 변경할 필요가 없습니다. 애플리케이션 에서 지원하는 경우 이 URI(Uniform Resource Identifier) 형식을 사용하세요. 그렇지 않은 경우 connectionStrings.privateEndpoint[n].connectionString을 사용합니다.

        • srvShardoptimdConnectionString 문자열

          mongodb+srv:// 프로토콜 사용하여 비공개 엔드포인트를 통해 MongoDB Cloud에 연결하는 샤딩된 클러스터에 최적화된 비공개 엔드포인트 인식 연결 문자열 . 연결 문자열 이 URI(Uniform Resource Identifier) 형식을 사용하는 경우 노드가 변경되더라도 URI(Uniform Resource Identifier)를 변경할 필요가 없습니다. 애플리케이션 및 Atlas cluster 지원하는 경우 이 URI(Uniform Resource Identifier) 형식을 사용하세요. 그렇지 않은 경우 connectionStrings.privateEndpoint[n].srvConnectionString에 대한 설명서를 사용하고 참조하세요.

        • 유형 문자열

          애플리케이션 이 연결되는 MongoDB 프로세스 유형입니다. 복제본 세트에는 MONGOD 을 사용하고 샤딩된 클러스터에는 MONGOS 을 사용합니다.

          값은 MONGOD 또는 MONGOS입니다.

      • privateSrv 문자열

        이 클러스터 에 연결하도록 구성한 각 인터페이스 가상 사설 클라우드( VPC ) 엔드포인트에 대한 네트워크 피어링 연결 문자열입니다. 이 연결 mongodb+srv:// 문자열 프로토콜 사용합니다. 리소스 누군가가 이 클러스터 에 대한 네트워크 피어링 연결 만들 때 이 매개변수를 반환합니다. 이 프로토콜 애플리케이션 에 DNS(Domain Name System)에서 호스팅하다 시드 목록 찾도록 지시합니다. 이 목록은 클러스터 의 노드와 동기화됩니다. 연결 문자열 이 URI(Uniform Resource Identifier) 형식을 사용하는 경우 노드가 변경되더라도 시드 목록 추가하거나 URI(Uniform Resource Identifier)를 변경할 필요가 없습니다. 운전자 에서 지원하는 경우 이 URI(Uniform Resource Identifier) 형식을 사용하세요.connectionStrings.private 그렇지 않은 경우 을 사용합니다. Amazon Web Services (AWS) 클러스터의 경우, 이 매개변수는 사용자 지정 DNS를 활성화 경우에만 반환됩니다.

        네트워크 피어링 연결
      • 표준 문자열

        이 클러스터 에 연결하는 데 사용할 수 있는 공개 연결 문자열 입니다. 이 연결 문자열 mongodb:// 프로토콜 사용합니다.

        연결 문자열 URI 형식
      • StandardSrv 문자열

        이 클러스터 에 연결하는 데 사용할 수 있는 공개 연결 문자열 입니다. 이 연결 문자열 mongodb+srv:// 프로토콜 사용합니다.

        연결 문자열 URI 형식
    • createate 문자열(날짜-시간)

      MongoDB Cloud가 이 클러스터를 생성한 날짜 및 시간입니다. 이 매개변수는 값을 UTC의 ISO 8601 형식으로 표현합니다.

    • diskSizeGB number(double)

      인스턴스 데이터 볼륨의 스토리지 용량은 기가바이트 단위로 표현됩니다. 용량을 추가하려면 이 숫자를 늘리세요.

      이 값은 M0/M2/M5 클러스터에서 구성할 수 없습니다.

      MongoDB Cloud는 replicationSpecs를 설정하는 경우 이 매개변수가 필요합니다.

      디스크 크기를 최소값(10GB) 미만으로 지정하면 이 매개변수는 기본값인 최소 디스크 크기 값으로 설정됩니다.

      스토리지 요금은 기본값을 선택하는지, 아니면 사용자 지정 값을 선택하는지에 따라 다르게 계산됩니다.

      선택한 클러스터의 최대 RAM의 50배를 초과할 수 없습니다. 더 많은 저장 공간이 필요한 경우 클러스터를 더 높은 티어로 업그레이드하는 것이 좋습니다.

      스토리지 사용자 지정
    • diskWarmingMode 문자열

      디스크 보온 모드 선택.

      값은 FULLY_WARMED 또는 VISIBLE_EARLIER입니다. 기본값은 FULLY_WARMED입니다.

      세컨더리 디스크 워밍(Warming) 영향 감소
    • encryptionAtRestProvider 문자열

      클러스터에 추가 저장 시 암호화 계층을 제공하기 위해 고객 키를 관리하는 클라우드 서비스 공급자. 미활성화 암호화를 위한 고객 키 관리를 활성화하려면 클러스터 replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize 설정을 M10 이상으로 지정하고 "backupEnabled" : false 또는 완전히 생략해야 합니다.

      값은 NONE, AWS, AZURE 또는 GCP입니다.

      고객 키 관리를 사용한 미사용 암호화
    • 기능 호환성 버전 문자열

      클러스터 의 기능 호환성 버전입니다.

    • featureCompatibilityVersionExpirationDate 문자열(날짜-시간)

      Feature compatibility version expiration date. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

    • globalClusterSelfManagedSharding 부울

      새 글로벌 클러스터를 생성할 때 샤딩 관리 모드를 구성하려면 이 필드를 설정합니다.

      false로 설정하면 관리 모드가 Atlas 관리 샤딩으로 설정됩니다. 이 모드는 글로벌 클러스터의 샤딩을 완벽하게 관리하며 원활한 배포 환경을 제공하도록 구축되었습니다.

      true로 설정하면 관리 모드가 자체 관리 샤딩으로 설정됩니다. 이 모드는 샤드 관리를 사용자에게 맡기며 유연한 고급 배포 환경을 제공하도록 설계되었습니다.

      클러스터가 배포된 후에는 이 설정을 변경할 수 없습니다.

      글로벌 클러스터 만들기
    • groupId 문자열

      프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.

      형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • id 문자열

      클러스터를 식별하는 고유한 24자리 16진수 문자열입니다.

      형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • labels 배열[객체] 더 이상 사용되지 않습니다.

      클러스터에 태그를 지정하고 분류하는 1~255자 길이의 키-값 쌍 컬렉션. MongoDB Cloud 콘솔에는 레이블이 표시되지 않습니다.

      클러스터 레이블은 더 이상 사용되지 않으며 향후 릴리스에서 제거될 예정입니다. 대신 리소스 태그를 사용할 것을 적극 권장합니다.

      이 MongoDB Cloud 구성 요소에 적용된 사람이 읽을 수 있는 레이블입니다.

      Resource Tags
      레이블 속성 숨기기 레이블 속성 표시 객체
      • 키 문자열

        이 구성 요소에 태그를 지정하다 하고 분류하는 데 적용되는 키입니다.

        최소 길이는 1, 최대 길이는 255입니다.

      • value 문자열

        이 구성 요소에 태그를 지정하다 하고 분류하는 데 적용된 키에 설정하다 값입니다.

        최소 길이는 1, 최대 길이는 255입니다.

    • 링크 배열[객체]

      API 하위 리소스, 관련 API 리소스 또는 둘 다를 점 하나 이상의 URL(Uniform Resource Locator) 목록입니다. RFC 5988 는 이러한 관계를 간략하게 설명합니다.

      웹 연결 사양(RFC 5988)
      링크 속성 숨기기 링크 속성 표시 객체
      • href 문자열

        이 응답과 관계 있는 다른 API 리소스 가리키는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

      • rel 문자열

        이 리소스 와 다른 API 리소스 간의 의미론적 관계 정의하는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

    • mongoDBEmployeeAccessGrant 객체

      클러스터에 대한 액세스 수준 및 만료 권한을 MongoDB 직원에게 부여했습니다.

      mongoDBEmployeeAccessGrant 속성 숨기기 mongoDBEmployeeAccessGrant 속성 표시 객체
      • expireTime 문자열(날짜-시간) 필수 사항

        직원에게 부여된 액세스의 만료일입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • grantType 문자열 필수 사항

        MongoDB 직원에게 부여할 액세스 수준입니다.

        값은 CLUSTER_DATABASE_LOGS, CLUSTER_INFRASTRUCTURE 또는 CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA입니다.

      • 링크 배열[객체]

        API 하위 리소스, 관련 API 리소스 또는 둘 다를 점 하나 이상의 URL(Uniform Resource Locator) 목록입니다. RFC 5988 는 이러한 관계를 간략하게 설명합니다.

        웹 연결 사양(RFC 5988)
        링크 속성 숨기기 링크 속성 표시 객체
        • href 문자열

          이 응답과 관계 있는 다른 API 리소스 가리키는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

        • rel 문자열

          이 리소스 와 다른 API 리소스 간의 의미론적 관계 정의하는 URL (Uniform Resource Locator)입니다. 이 URL https://cloud.mongodb.com/api/atlas로 시작하는 경우가 많습니다.

    • mongoDBMajorVersion 문자열

      클러스터의 MongoDB 주요 버전입니다.

      생성 시: 사용 가능한 MongoDB 버전 중에서 선택하거나 현재 권장되는 기본값을 지정하지 않고 그대로 두어 MongoDB 클라우드 플랫폼에서 사용할 수 있습니다. 권장되는 버전은 최신 LTS(장기 지원) 버전입니다. 기본값은 전체 릴리스 주기 동안 가장 최근에 릴리스된 버전으로 보장되지 않습니다. 특정 프로젝트에서 사용할 수 있는 버전을 알아보려면 링크된 문서를 참조하거나 프로젝트 LTS 버전 엔드포인트에 대한 API 엔드포인트를 사용하세요.

      업데이트 시: 한 번에 1개의 주요 버전만 버전을 증가시킵니다. 클러스터가 현재 MongoDB 버전보다 정확히 한 주요 버전 낮은 MongoDB 기능 호환성 버전에 고정되어 있는 경우, MongoDB 버전을 이전 주요 버전으로 다운그레이드할 수 있습니다.

      Atlas에서 사용 가능한 MongoDB 버전
    • mongoDBVersion 문자열

      클러스터가 실행하는 MongoDB 버전.

      형식은 ([\d]+\.[\d]+\.[\d]+) 패턴 과 일치해야 합니다.

    • 이름 문자열

      고급 클러스터를 식별하는 인간 판독 가능 레이블.

      형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

    • paused 부울

      클러스터의 일시 중지 여부를 나타내는 플래그.

    • pitEnabled 부울

      클러스터의 지속적인 클라우드 백업 사용 여부를 나타내는 플래그.

      지속적인 클라우드 백업
    • replicaSetScalingStrategy 문자열

      이 필드를 설정하여 클러스터의 복제본 세트 스케일링 모드를 구성합니다.

      기본적으로 Atlas는 WORKLOAD_TYPE에 따라 확장됩니다. 이 모드를 사용하면 Atlas가 운영 노드와 함께 분석 노드를 병렬 확장할 수 있습니다.

      SEQUENTIAL로 구성된 경우 Atlas는 모든 노드를 순차적으로 확장합니다. 이 모드는 안정된 상태의 워크로드 및 지연 시간에 민감한 세컨더리 읽기를 수행하는 애플리케이션을 대상으로 합니다.

      NODE_TYPE으로 구성하면 Atlas는 읽기 전용 및 분석 노드와 병렬로 선택 가능한 노드를 확장합니다. 이 모드는 자주 그리고 신속한 클러스터 계층 확장이 필요한 대규모 동적 워크로드에 적합합니다. 이는 가장 빠른 확장 전략이지만 광범위한 세컨더리 읽기 작업을 수행할 때 워크로드 지연에 영향을 미칠 수 있습니다.

      값은 SEQUENTIAL, WORKLOAD_TYPE 또는 NODE_TYPE입니다. 기본값은 WORKLOAD_TYPE입니다.

      복제본 세트 확장 모드 수정
    • replicationSpecs 배열[객체]

      클러스터 리전을 구성하는 설정 목록. 글로벌 클러스터의 경우 배열의 각 객체는 클러스터 노드 배포 영역을 나타냅니다. 글로벌이 아닌 샤딩된 클러스터 및 복제본 세트의 경우 이 배열에는 클러스터 노드 배포 위치를 나타내는 객체가 하나 포함됩니다.

      MongoDB Cloud가 지정된 MongoDB database 에 데이터를 복제하는 방법을 설명하는 세부 정보입니다.

      replicationSpecs 속성 숨기기 replicationSpecs 속성 표시 객체
      • id 문자열

        멀티 클라우드 클러스터에서 구역 에 대한 복제 객체 식별하는 고유한 24-16진수 문자열입니다. 요청 에 기존 구역을 포함하는 경우 이 매개변수를 지정해야 합니다. 기존 멀티클라우드 클러스터에 새 구역 추가하는 경우 이 매개변수를 지정할 수 있습니다. 이 요청 요청 에서 제외한 멀티클라우드 클러스터의 기존 구역을 모두 삭제합니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • numShards integer(int32)

        지정된 각 구역 에 배포 할 샤드 수를 지정하는 양의 정수입니다. 이 값을 1 로 설정하다 clusterType 이 SHARDED인 경우 MongoDB Cloud는 단일 샤딩된 클러스터 배포합니다. 프로덕션 환경에서는 단일 샤드 로 샤딩된 클러스터 생성하지 마세요. 단일 샤드 샤딩된 클러스터는 다중 샤드 구성과 동일한 이점을 제공하지 않습니다.

        복제본 세트 샤딩된 클러스터 로 업그레이드하는 경우 동일한 업데이트 요청 에서 샤드 수를 늘릴 수 없습니다. 샤드를 추가하기 전에 클러스터 샤딩된 로의 업그레이드를 완료하고 모든 애플리케이션 클라이언트를 MongoDB 라우터에 다시 연결할 때까지 기다려야 합니다. 그렇지 않으면 MongoDB Cloud가 샤드 전체에 데이터를 배포하기 시작할 때 데이터가 일관되지 않을 수 있습니다.

        최소값은 1입니다.

      • regionConfigs 배열[객체]

        특정 리전 에 설정하다 노드의 하드웨어 사양입니다. 각 regionConfigs 객체 replicationSpec 내에서 리전 및 cloud 제공자 에 따라 고유해야 합니다.각 regionConfigs 객체 선거에서 리전의 우선 순위 와 MongoDB Cloud가 해당 리전 에 배포하는 MongoDB 노드의 수 및 유형을 설명합니다. 각 regionConfigs 객체 analyzeSpecs 객체,ectableSpecs 객체 또는 readOnlySpecs 객체 가 있어야 합니다. 테넌트 클러스터에는 eltableSpecs만 필요합니다. 전용 클러스터는 이러한 사양 중 하나를 지정할 수 있지만 replicationSpec 내에 ectableSpecs 객체 하나 이상 있어야 합니다. 모든 hardware 사양은 동일한 인스턴스 크기를 사용해야 합니다.

        예시:

        "replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize" : "M30" 설정하다 설정하다 경우 "replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" :"M30"if you have electable nodes and"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize" : 읽기 전용 노드가 있는 경우 "M30".

        다음 중 하나입니다.
        AWS 객체 AZURE 객체 GCP 객체 TENANT 객체
      • zoneId 문자열

        글로벌 클러스터의 구역 식별하는 고유한 24-16진수 문자열입니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • zoneName 문자열

        글로벌 클러스터의 구역 식별하는 사람이 읽을 수 있는 레이블입니다. "clusterType" : "GEOSHARDED"인 경우에만 이 값을 제공하세요.

    • rootCertType 문자열

      MongoDB Atlas cluster 사용하는 루트 인증 기관. MongoDB Cloud는 Internet Security Research 그룹을 지원합니다.

      값은 ISRGROOTX1입니다. 기본값은 ISRGROOTX1입니다.

    • stateName 문자열

      Atlas 컨트롤 플레인이 이 클러스터 에서 수행 중인 모든 활동을 나타내는 사람이 읽을 수 있는 레이블입니다. 생성 중 및 삭제 중 상태를 제외하고 클러스터는 항상 사용 가능해야 하며 진행 중인 활동을 나타내는 상태에 있는 경우에도 프라이머리 노드 있어야 합니다.

      • IDLE: Atlas 이 클러스터 를 변경하지 않으며 UI 또는 API 통해 요청된 모든 변경 사항이 적용된 것으로 가정할 수 있습니다.
      • CREATING: 처음으로 프로비저닝되는 클러스터 연결 준비가 될 때까지 CREATING 상태 반환합니다. 연결을 시도하기 전에 IP 액세스 목록 및 DB 사용자가 구성되어 있는지 확인합니다.
      • UPDATING: UI, API, AutoScaling 또는 기타 예약된 활동을 통해 요청된 변경이 발생하고 있습니다.
      • DELETING: 클러스터 삭제하는 프로세스 곧 삭제될 예정입니다.
      • REPAIRING: 클러스터 에 있는 하나 이상의 노드가 Atlas 컨트롤 플레인에 의해 서비스로 반환되고 있습니다. 다른 노드는 정상적으로 계속 서비스를 제공해야 합니다.

      값은 IDLE, CREATING, UPDATING, DELETING 또는 REPAIRING입니다.

    • tags 배열[객체]

      클러스터에 태그를 지정하고 분류하기 위한 1~255자 길이의 키-값 쌍이 포함된 목록입니다.

      MongoDB Cloud 조직, 프로젝트 또는 클러스터 태그를 지정하고 분류하는 키-값 쌍입니다. 예시: environment : production.

      Resource Tags
      Hide tags attributes 태그 속성 표시 객체
      • 키 문자열 필수 사항

        태그 세트를 정의하는 상수입니다. 예를 들어 environment : production 태그의 environment 입니다.

        최소 길이는 1, 최대 길이는 255입니다.

      • value 문자열 필수 사항

        태그 세트에 속하는 변수입니다. 예를 들어 environment : production 태그의 production 입니다.

        최소 길이는 1, 최대 길이는 255입니다.

    • terminationProtectionEnabled 부울

      클러스터의 종료 보호 활성화 여부를 나타내는 플래그. true로 설정하면 MongoDB Cloud가 클러스터를 삭제하지 않습니다. false로 설정하면 MongoDB Cloud가 클러스터를 삭제합니다.

      기본값은 false 입니다.

    • versionReleaseSystem 문자열

      클러스터가 MongoDB 버전을 유지 관리하는 방법입니다. 값이 CONTINUOUS인 경우 mongoDBMajorVersion을 지정하지 않아야 합니다.

      값은 LTS 또는 CONTINUOUS입니다. 기본값은 LTS입니다.
  • 400 application/json

    잘못된 요청입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 401 application/json

    승인되지 않았습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 403 application/json

    Forbidden.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 409 application/json

    Conflict.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
PATCH /API/Atlas/v2/groups/{groupId}/clusters/{clusterName} 
atlas api clusters updateGroupCluster --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.UpdateGroupClusterApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		UpdateGroupClusterWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-05-30+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.2024-05-30+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"
  },
  "backupEnabled": false,
  "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": "string",
  "name": "string",
  "paused": true,
  "pitEnabled": true,
  "replicaSetScalingStrategy": "WORKLOAD_TYPE",
  "replicationSpecs": [
    {
      "numShards": 42,
      "regionConfigs": [
        {
          "": {
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10",
            "nodeCount": 42
          },
          "priority": 42,
          "providerName": "AWS",
          "regionName": "US_GOV_WEST_1",
          "analyticsAutoScaling": {
            "compute": {
              "enabled": true,
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "analyticsSpecs": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          },
          "autoScaling": {
            "compute": {
              "enabled": true,
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "readOnlySpecs": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          }
        }
      ],
      "zoneName": "string"
    }
  ],
  "rootCertType": "ISRGROOTX1",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false,
  "versionReleaseSystem": "LTS"
}
응답 예시(200) 
{
  "acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
  "advancedConfiguration": {
    "customOpensslCipherConfigTls12": [
      "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
    ],
    "minimumEnabledTlsProtocol": "TLS1_0",
    "tlsCipherConfigMode": "CUSTOM"
  },
  "backupEnabled": false,
  "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": "string",
  "mongoDBVersion": "string",
  "name": "string",
  "paused": true,
  "pitEnabled": true,
  "replicaSetScalingStrategy": "WORKLOAD_TYPE",
  "replicationSpecs": [
    {
      "id": "32b6e34b3d91647abb20e7b8",
      "numShards": 42,
      "regionConfigs": [
        {
          "": {
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10",
            "nodeCount": 42
          },
          "priority": 42,
          "providerName": "AWS",
          "regionName": "US_GOV_WEST_1",
          "analyticsAutoScaling": {
            "compute": {
              "enabled": true,
              "": "M10",
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "analyticsSpecs": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          },
          "autoScaling": {
            "compute": {
              "enabled": true,
              "": "M10",
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "readOnlySpecs": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          }
        }
      ],
      "zoneId": "32b6e34b3d91647abb20e7b8",
      "zoneName": "string"
    }
  ],
  "rootCertType": "ISRGROOTX1",
  "stateName": "IDLE",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false,
  "versionReleaseSystem": "LTS"
}
응답 예시(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"
}
응답 예시(409) 
{
  "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"
}
응답 예시(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"
}