공개 미리 보기: 다음에서 피드백 제공하세요. 요청하는 API 키가 액세스 할 수 있는 모든 조직을 반환합니다.
이 리소스를 사용하려면 요청하는 API 키에 조직 구성원 역할이 있어야 합니다.
이 명령은 자동으로 생성되며 1 1 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/# 태그를 지정하다/Organizations/를 사용하여: 에 해당합니다. operation/listOrganizations.
자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.
구문
atlas api organizations listOrganizations [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--envelope | envelope | 거짓 | 애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다. |
-h, --help | 거짓 | listOrganizations 도움말 | |
--includeCount | 거짓 | 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다. | |
--itemsPerPage | int | 거짓 | 페이지당 응답이 반환하는 항목 수입니다. |
--name | 문자열 | 거짓 | 반환된 목록을 필터링하는 데 사용할 조직의 사람이 읽을 수 있는 레이블입니다. 지정된 이름으로 시작하는 조직에 대해 대소문자를 구분하지 않는 검색을 수행합니다. |
--출력 | 문자열 | 거짓 | 기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다. |
--출력 파일 | 문자열 | 거짓 | API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다. |
--pageNum | int | 거짓 | 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다. |
--pretty | 거짓 | 응답 본문을 <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">pretty-print</a> 형식입니다. | |
--version | 문자열 | 거짓 | API 호출 시 사용할 API 버전 [옵션: "2023-01-01"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 이 값 기본값은 '2023-01-01". |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
예시
아래 명령을 실행합니다.
atlas api organizations listOrganizations --version 2023-01-01 --envelope false --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false