- 이 버전의 문서는 보관되어 더 이상 지원되지 않습니다. 최신 문서 를 참조하여 Atlas CLI 버전을 업그레이드 하는 방법을 학습 보세요.
atlas api streams getStreamWorkspace 을(를) 사용하세요. 자세히 학습하려면 atlas api streams getStreamWorkspace를 참조하세요.프로젝트에 대한 Atlas Stream Processing 인스턴스를 설명합니다.
공개 미리 보기: MongoDB Atlas 관리자 API 에서 자동으로 생성된 Atlas API 하위 명령은 관리자 API 에 대한 전체 기능을 제공하며 현재 공개 미리 보기로 제공됩니다( 피드백 https://feedback.mongodb.com/forums/930808-Atlas-cli). 관리자 API 기능에는 자체 출시하다 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.
이 명령을 사용하려면 프로젝트 읽기 전용 역할이 있는 사용자 계정 또는 API 키로 인증해야 합니다.
구문
atlas streams instances describe <name> [options]
arguments
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
이름 | 문자열 | true | Atlas Streams 인스턴스의 이름입니다. |
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-h, --help | 거짓 | 설명 도움말 | |
-o, --output | 문자열 | 거짓 | 출력 형식입니다. 유효한 값은 json, json-path, go-템플릿 또는 go-템플릿 파일입니다. 전체 출력을 보려면 -o json 옵션을 사용합니다. |
--projectId | 문자열 | 거짓 | 사용할 프로젝트를 식별하는 16진수 문자열입니다. 이 옵션은 구성 파일 또는 환경 변수의 설정을 재정의합니다. |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
출력
명령이 성공하면 Atlas CLI는 다음 샘플과 유사한 출력을 반환합니다. 괄호 안의 값은 사용자의 값을 나타냅니다.
ID NAME CLOUD REGION <Id> <Name> <DataProcessRegion.CloudProvider> <DataProcessRegion.Region>
예시
# Return an Atlas Stream Processing instance with a specific name: atlas streams instance describe myProcessor
# Return a JSON-formatted Atlas Stream Processing instance with a specific name: atlas streams instance describe myProcessor --output json