atlas api clusters updateCluster

Atlas 관리 API 로 명령을 실행 위한 Atlas CLI 지원 Preview 중입니다. 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. 자세히 학습 미리보기 기능을 참조하세요.

공개 미리 보기: 피드백 제공하세요: 지정된 프로젝트 의 한 클러스터 에 대한 세부 정보를 업데이트합니다.

공개 미리 보기: MongoDB Atlas 관리자 API 에서 자동으로 생성된 Atlas API 하위 명령은 관리자 API 에 대한 전체 기능을 제공하며 현재 공개 미리 보기로 제공됩니다( 피드백 https://feedback.mongodb.com/forums/930808-Atlas-cli). 관리자 API 기능에는 자체 출시하다 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.

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

이 명령은 자동으로 생성되며 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/api/doc/atlas-admin-api-v2/operation/operation-updatecluster와 1:1 에 해당합니다. .

자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.

구문

명령 구문

atlas api clusters updateCluster [options]

옵션

이름	유형	필수 사항	설명
--clusterName	문자열	true	클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
--envelope	envelope	거짓	애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
--file	문자열	거짓	API 요청 파일 의 경로입니다. 표준 입력을 대신 사용하려면 비워 두세요 - 둘 중 하나를 제공해야 하지만 둘 다 제공할 수는 없습니다.
--groupId	문자열	true	프로젝트 식별하는 고유한 24-16진수 문자열입니다. [/groups](# 태그를 지정하다 /Projects/operation/listProjects) 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 . 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
-h, --help		거짓	updateCluster에 대한 도움말
-o, --output	문자열	거짓	기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다.
--outputFile	문자열	거짓	API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다.
--pretty		거짓	응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
--version	문자열	거짓	API 호출 시 사용할 API 버전 [options: "2023-01-01", "2023-02-01", "2024-08-05", "2024-10-23"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우)입니다. 이 값의 기본값은 "2024-10-23"입니다.
-w, --watch		거짓	명령이 실행이 완료되거나 감시 시간이 초과될 때까지 명령을 감시할지 여부를 나타내는 플래그입니다.
--watchTimeout	int	거짓	watch 시간이 초과될 때까지의 시간(초)입니다. 감시 시간이 초과되면 Atlas CLI는 더 이상 명령을 감시하지 않습니다.

상속된 옵션

이름	유형	필수 사항	설명
-P, --profile	문자열	거짓	구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요.

예시

클러스터 업데이트하여 디스크 크기를 20GB 로 늘리고 노드 수를 5로 늘립니다.

아래 파일 생성하고 다음 이름으로 저장합니다. payload.json

{
  "replicationSpecs": [
    {
      "regionConfigs": [
        {
          "electableSpecs": {
            "diskSizeGB": 20,
            "instanceSize": "M10",
            "nodeCount": 5
          },
          "priority": 7,
          "providerName": "AWS",
          "regionName": "US_EAST_1"
        }
      ]
    }
  ]
}

payload.json를 생성한 후 동일한 디렉토리 에서 아래 명령을 실행 .

atlas api clusters updateCluster --version 2024-10-23 --clusterName [your-cluster-name] --groupId [your-project-id]

돌아가기

unpinFeatureCompatibilityVersion

updateClusterAdvancedConfiguration