공개 미리 보기: 다음에서 피드백 제공하세요: 지정된 프로젝트 에 대한 스트림 인스턴스 의 모든 연결을 반환합니다.
이 리소스를 사용하려면 요청 API 키에 프로젝트 데이터 액세스 역할, 프로젝트 소유자 역할 또는 프로젝트 스트림 프로세싱 소유자 역할이 있어야 합니다.
이 명령은 자동으로 1 생성되며:1 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/atlas/reference/api-resources-spec/v2/# 태그를 지정하다/Streams/에 해당합니다. operation/listStreamConnections.
자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.
구문
atlas api streams listStreamConnections [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--envelope | envelope | 거짓 | 애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다. |
--groupId | 문자열 | true | 프로젝트 식별하는 고유한 24-16진수 문자열입니다. [/groups](# 태그를 지정하다 /Projects/operation/listProjects) 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 . 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다. |
-h, --help | 거짓 | listStreamConnections 도움말 | |
--itemsPerPage | int | 거짓 | 페이지당 응답이 반환하는 항목 수입니다. |
--출력 | 문자열 | 거짓 | 기본 설정 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> 형식입니다. | |
--tenantName | 문자열 | true | 스트림 인스턴스를 식별하는 사람이 읽을 수 있는 레이블입니다. |
--version | 문자열 | 거짓 | API 호출 시 사용할 API 버전 [옵션: "2023-02-01"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 이 값 기본값은 '2023-02-01". |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
예시
아래 명령을 실행합니다.
atlas api streams listStreamConnections --version 2023-02-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --itemsPerPage 100 --pageNum 1 --pretty false --tenantName [tenantName]