Event Streams CLI 참조
Event Streams용 CLI 설치 방법에 대한 정보를 보려면 Event Streams CLI 시작하기를 참조하십시오.
변경 로그
| 버전 | 릴리스 날짜 | 변경사항 |
|---|---|---|
| v1.0 | 2019년 5월 12일 |
|
| v1.0.1 | 2019년 5월 27일 | -초기화하지 않고 명령을 실행할 때 오류 메시지가 개선되었습니다. -초기화 중 정렬된 인스턴스 목록. -변환 업데이트. |
| v2.0 | 2019년 8월 21일 |
|
| v2.1 | 2020년 6월 24일 | -init: 엔터프라이즈 인스턴스에 대한 프로비저닝 매개변수를 표시합니다. -변환 업데이트. |
| v2.1.1 | 2020년 7월 10일 |
|
| v2.2.0 | 2020년 8월 3일 |
|
| v2.2.1 | 2020년 8월 7일 |
|
| v2.3 | 2020년 11월 9일 | -주제에 대한 메시지 감사 구성 지원이 추가되었습니다. -init: 매개변수 kms_key_crn이 프로비저닝에 지정된 경우 암호화 키를 표시합니다. |
| v2.3.2 | 2022년 5월 5일 |
|
| v2.4.0 | 2023년 2월 28일 |
|
| v2.4.1 | 2023년 12월 5 일 |
|
| v2.5.0 | 2023년 12월 15 일 |
|
| v2.6.0 | 2024년 8월 29일 |
|
| v2.6.1 | 2024년 11월 01일 |
|
| v2.6.2 | 2025년 2월 1일 |
|
| v2.7.0 | 2025년 2월 25일 |
|
| v2.7.1 | 2025년 5월 1일 |
|
| v2.7.3 | 2026년 4월 29일 |
|
ibmcloud es init
Event Streams 플러그인을 초기화하십시오.
ibmcloud es init [-i|--instance-name INSTANCE_NAME] [-a|--api-url API_ENDPOINT_URL]
전제조건: 없음
명령 옵션:
- --instance-name 값, -i 값(선택사항)
- Event Streams 인스턴스의 이름입니다.
- --api-url 값, -a 값(선택사항)
- Event Streams 인스턴스의 Kafka 관리 URL입니다.
ibmcloud es broker
특정 브로커의 세부 정보를 표시합니다.
ibmcloud es broker [--broker] ID [--json]
전제조건: 없음
명령 옵션:
- --broker 값, -b 값
- 브로커 ID. 선행 '--broker' 플래그와 함께 또는 이 플래그 없이 지정할 수 있습니다.
- --json(선택사항)
- JSON의 출력 형식입니다.
ibmcloud es broker-config
브로커의 구성을 표시합니다.
ibmcloud es broker-config [--broker] ID [--filter FILTER] [--verbose] [--json]
전제조건: 없음
명령 옵션:
- --broker 값, -b 값
- 브로커 ID. 선행 '--broker' 플래그와 함께 또는 이 플래그 없이 지정할 수 있습니다.
- --filter 값, -f 값(선택사항)
- 와일드카드(*) 또는 슬래시(/) 구분 기호가 있는 정규식을 사용하여 구성 목록을 필터링합니다.
- --verbose, -v(선택사항)
- 자세한 구성 정보를 표시합니다.
- --json(선택사항)
- JSON의 출력 형식입니다.
ibmcloud es cluster
모든 브로커의 세부 정보 및 Kafka 버전을 포함하여 클러스터의 세부 정보를 표시합니다.
ibmcloud es cluster [--json]
전제조건: 없음
명령 옵션:
- --json(선택사항)
- JSON의 출력 형식입니다.
ibmcloud es topic
토픽의 세부사항을 표시합니다.
ibmcloud es topic [--name] TOPIC_NAME [--json]
전제조건: 없음
명령 옵션:
- --name 값, -n 값
- 토픽 이름입니다.
- --json(선택사항)
- JSON의 출력 형식입니다.
ibmcloud es topic-create
새 토픽을 작성합니다.
ibmcloud es topic-create [--name] TOPIC_NAME [--partitions PARTITIONS] [--config KEY=VALUE[;KEY=VALUE]* ]*
전제조건: 없음
명령 옵션:
- --name 값, -n 값
-
토픽 이름입니다.
- --partitions 값, -p 값
-
토픽의 파티션 수를 설정합니다.
- --config KEY=VALUE, -c KEY=VALUE(선택사항)
-
토픽의 구성 옵션을 KEY=VALUE 쌍으로 설정합니다.
-
여러 개의 --config 옵션을 지정할 수 있습니다. 각 '--config' 옵션은 세미콜론으로 구분된 지정 목록을 지정할 수 있습니다. 다음 목록은 유효한 구성 키를 표시합니다.
- cleanup.policy
- retention.ms
- retention.bytes
- segment.bytes
- segment.ms
- segment.index.bytes
ibmcloud es topic-delete
토픽을 삭제합니다.
ibmcloud es topic-delete [--name] TOPIC_NAME [--force]
전제조건: 없음
명령 옵션:
- --name 값, -n 값
- 토픽 이름입니다.
- --force, -f(선택사항)
- 확인 없이 삭제합니다.
ibmcloud es topic-delete-records
지정된 오프셋의 토픽에서 레코드를 삭제합니다.
ibmcloud es topic-delete-records [--name] TOPIC_NAME [--partition-offset PARTITION:OFFSET[;PARTITION:OFFSET]* ]* [--force]
전제조건: 없음
명령 옵션:
- --name 값, -n 값
- 토픽 이름입니다.
- --partition-offset PARTITION:OFFSET, -p PARTITION:OFFSET
- PARTITION:OFFSET 형식의 레코드를 삭제할 파티션 및 오프셋입니다.
- 여러 --partition-offset 옵션을 지정하거나 세미콜론 구분 기호를 사용하는 여러 PARTITION:OFFSET 쌍을 인용 부호로 묶어 지정할 수 있습니다('PARTITION1:OFFSET1;PARTITION2:OFFSET2;PARTITION3:OFFSET3').
- --force, -f(선택사항)
- 확인 없이 레코드를 삭제합니다.
ibmcloud es topic-partitions-set
토픽에 대한 파티션을 설정합니다.
ibmcloud es topic-partitions-set [--name] TOPIC_NAME --partitions PARTITIONS
전제조건: 없음
명령 옵션:
- --name 값, -n 값
- 토픽 이름입니다.
- --partitions 값, -p 값
- 토픽의 파티션 수를 설정합니다.
ibmcloud es topic-update
토픽의 구성을 업데이트합니다.
ibmcloud es topic-update [--name] TOPIC_NAME --config KEY[=VALUE][;KEY[=VALUE]]* [--default]
전제조건: 없음
명령 옵션:
- --name 값, -n 값
-
토픽 이름입니다.
- --config KEY[=VALUE], -c KEY[=VALUE]
-
토픽에 대한 구성 옵션을 KEY[=VALUE] 쌍으로 설정하십시오.
-
VALUE가 제공되지 않으면 '--default' 플래그를 지정하여 구성 값을 기본값으로 다시 재설정함을 나타냅니다. '--config' 옵션을 여러 개 지정할 수 있습니다. 각 '--config' 옵션은 세미콜론으로 구분된 지정 목록을 지정할 수 있습니다. 다음 목록은 유효한 구성 키를 표시합니다.
- cleanup.policy
- retention.ms
- retention.bytes
- segment.bytes
- segment.ms
- segment.index.bytes
- --default, -d(선택사항)
-
'--config' 을 사용하여 지정한 각 구성 매개변수를 기본값으로 재설정합니다.
ibmcloud es topics
토픽을 나열합니다.
ibmcloud es topics [--filter FILTER] [--json]
전제조건: 없음
명령 옵션:
- --filter 값, -f 값(선택사항)
- 토픽 이름입니다.
- --json(선택사항)
- 출력 형식을 JSON으로 지정합니다. 최대 1000개의 토픽이 리턴됩니다.
ibmcloud es group
이용자 그룹의 세부사항을 표시합니다.
ibmcloud es group [--group] GROUP_ID [--json]
> 전제조건: 없음
명령 옵션:
- --group 값, -g 값
- 이용자 그룹 ID입니다.
- --json(선택사항)
- 출력 형식을 JSON으로 지정합니다.
ibmcloud es group-reset
이용자 그룹의 오프셋을 재설정합니다.
ibmcloud es group-reset [--group] GROUP_ID [--topic TOPIC_NAME] [--all-topics] --mode MODE --value VALUE [--dry-run] [--execute] [--json]
전제조건: 없음
명령 옵션:
- --group 값, -g 값
- 이용자 그룹 ID
- --topic 값, -t 값
- 토픽 이름입니다. 이 토픽에 적용합니다. '--all-topics' 플래그가 제공된 경우 생략합니다.
- --all-topics, -a
- 그룹에 지정된 모든 토픽을 적용합니다. '--topic' 플래그가 지정된 경우 생략합니다.
- --mode 값, -m 값
- 다음 값 중 하나: 'earliest', 'latest' 또는 'datetime'.
- --value 값, -v 값
- 오프셋 재설정을 위한 값이며 '--mode'를 기반으로 합니다. 'earliest' 및 'latest'의 경우 생략합니다. 'datetime': 'YYYY-MM-DDTHH:mm:SS.sss[±hh:mm|Z]'를 사용합니다.
- --dry-run(선택사항)
- 결과를 표시하고 변경사항을 구현하지 않습니다.
- --execute(선택사항)
- 오프셋에 대한 변경사항을 실행합니다.
- --json(선택사항)
- 출력 형식을 JSON으로 지정합니다.
ibmcloud es groups
이용자 그룹을 나열합니다.
ibmcloud es groups [--filter FILTER] [--json]
전제조건: 없음
명령 옵션:
- --filter 값, -f 값(선택사항)
- 선택사항입니다. 와일드카드(*) 또는 슬래시(/) 구분 기호가 있는 정규식을 사용하여 이용자 그룹 목록을 필터링합니다.
- --json(선택사항)
- 출력 형식을 JSON으로 지정합니다. 최대 1000개의 그룹이 리턴됩니다.
ibmcloud es group-delete
이용자 그룹을 삭제합니다.
ibmcloud es group-delete [--group] GROUP_ID [--force]
전제조건: 없음
명령 옵션:
- --group 값, -g 값
- 이용자 그룹 ID
- --force, -f(선택사항)
- 확인 없이 그룹을 삭제합니다.
ibmcloud es mirroring-topic-selection
미러링 토픽 선택사항을 나열합니다.
ibmcloud es mirroring-topic-selection [--json]
전제조건: Event Streams 인스턴스에서 미러링이 사용으로 설정되었습니다. Event Streams 플러그인이 ibmcloud es init 를 통해 미러링 대상 클러스터에 연결하도록 구성되었습니다.
명령 옵션:
- --json(선택사항)
- 출력 형식을 JSON으로 지정합니다.
ibmcloud es mirroring-topic-selection-set
미러링 토픽 선택사항을 대체합니다.
ibmcloud es mirroring-topic-selection-set (--select pattern1,pattern2 | --none) [--force]
전제조건: Event Streams 인스턴스에서 미러링이 사용으로 설정되었습니다. Event Streams 플러그인이 ibmcloud es init 를 통해 미러링 대상 클러스터에 연결하도록 구성되었습니다.
명령 옵션:
- --select value
- 쉼표로 구분된 정규식 패턴으로 미러링할 토픽 선택. '.*'를 사용하여 모든 토픽을 미러링합니다.
- --none
- 현재 선택된 토픽을 선택 취소합니다(토픽의 미러링 사용 안함).
- --force
- 선택사항입니다. 확인하지 않고 미러링 토픽 선택사항을 대체합니다.
ibmcloud es mirroring-active-topics
현재 미러링 중인 토픽을 가져옵니다.
ibmcloud es mirroring-active-topics [--json]
전제조건: Event Streams 인스턴스에서 미러링이 사용으로 설정되었습니다. Event Streams 플러그인이 ibmcloud es init 를 통해 미러링 대상 클러스터에 연결하도록 구성되었습니다.
명령 옵션:
- --json(선택사항)
- 출력 형식을 JSON으로 지정합니다.
ibmcloud es 도움말
명령에 대한 도움말을 표시하거나 모든 명령을 나열합니다.
ibmcloud es help [COMMAND]
전제조건: 없음
명령 옵션:
- COMMAND (선택사항)
- 명령에 대한 도움말을 표시합니다.
ibmcloud es schema-가져오기
zip 파일에서 레지스트리로 스키마 세트를 가져오십시오.
ibmcloud es schema-import [--file] ZIP_FILE_PATH
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --file 값, -f 값
- Zip 파일 경로입니다.
IBM클라우드 ES 스키마
레지스트리에서 스키마를 나열합니다.
ibmcloud es schemas [--json]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --json
- 선택사항입니다. 출력 형식을 JSON으로 지정합니다.
IBM클라우드 ES 스키마 생성
스키마를 만듭니다.
ibmcloud es schema-create [--artifact-id SCHEMA_ID] --file PATH_TO_FILE [--json]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --artifact-id 값
- 선택사항입니다. 생성할 스키마 아티팩트의 ID입니다. 제공하지 않으면 ID가 생성됩니다.
- --file 값
- 생성할 스키마의 JSON 정의가 포함된 파일의 경로입니다.
- --json
- 선택사항입니다. 출력 형식을 JSON으로 지정합니다.
IBM클라우드 ES 스키마
스키마에 대한 정보를 표시합니다.
ibmcloud es schema [--artifact-id] SCHEMA_ID [--json]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --artifact-id 값
- 스키마의 ID입니다.
- --json
- 선택사항입니다. 출력 형식을 JSON으로 지정합니다.
IBM클라우드 ES 스키마 업데이트
스키마의 상태를 변경합니다.
ibmcloud es schema-update [--artifact-id] SCHEMA_ID --set ENABLED|DISABLED
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --artifact-id 값
- 스키마의 ID입니다.
- --set 값
- 스키마의 새 상태는 '활성화' 또는 '비활성화'여야 합니다.
IBM클라우드 ES 스키마 삭제
스키마를 삭제합니다.
ibmcloud es schema-delete [--artifact-id] SCHEMA_ID [--force]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다. 스키마는 비활성화 상태여야 합니다.
명령 옵션:
- --artifact-id 값
- 스키마의 ID입니다.
- --force
- 선택사항입니다. 확인 없이 스키마를 삭제합니다.
IBM클라우드 ES 스키마 버전
스키마 버전을 표시합니다.
ibmcloud es schema-versions [--artifact-id] SCHEMA_ID [--json]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --artifact-id 값
- 스키마의 ID입니다.
- --json
- 선택사항입니다. 출력 형식을 JSON으로 지정합니다.
ibmcloud es 스키마 버전 생성
스키마의 새 버전을 만듭니다.
ibmcloud es schema-version-create [--artifact-id] SCHEMA_ID --file PATH_TO_FILE [--json]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --artifact-id 값
- 새 버전을 만들 스키마 아티팩트의 ID입니다.
- --file 값
- 생성할 스키마 버전의 JSON 정의가 포함된 파일의 경로입니다.
- --json
- 선택사항입니다. 출력 형식을 JSON으로 지정합니다.
IBM클라우드 ES 스키마 버전
스키마 버전에 대한 정보를 표시합니다.
ibmcloud es schema-version [--artifact-id SCHEMA_ID --version VERSION] [--global-id GLOBAL_ID] [--json]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다. --artifact-id 및 --version 플래그 또는 --global-id 플래그를 사용합니다.
명령 옵션:
- --artifact-id 값
- 스키마 아티팩트의 ID입니다.
- --version 값
- 표시할 버전입니다.
- --global-id 값
- 표시할 스키마 버전의 글로벌 ID입니다.
- --json
- 선택사항입니다. 출력 형식을 JSON으로 지정합니다.
IBM클라우드 ES 스키마 버전 업데이트
스키마 버전의 상태를 변경합니다.
ibmcloud es schema-version-update [--artifact-id] SCHEMA_ID --version VERSION --set ENABLED|DISABLED
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --artifact-id 값
- 스키마 아티팩트의 ID입니다.
- --version 값
- 업데이트할 버전입니다.
- --set 값
- 스키마 버전의 새 상태는 '활성화됨' 또는 '비활성화됨' 중 하나여야 합니다.
- --json
- 선택사항입니다. 출력 형식을 JSON으로 지정합니다.
ibmcloud es 스키마-버전-삭제
스키마 버전을 삭제합니다.
ibmcloud es schema-version-delete [--artifact-id] SCHEMA_ID --version VERSION [--force]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다. 스키마 버전은 비활성화 상태여야 합니다.
명령 옵션:
- --artifact-id 값
- 스키마 아티팩트의 ID입니다.
- --version 값
- 삭제할 버전입니다.
- --force
- 선택사항입니다. 확인 없이 스키마 버전을 삭제합니다.
ibmcloud es 스키마 호환성 규칙 생성
스키마 호환성 규칙을 만듭니다.
ibmcloud es schema-compatibility-rule-create [--artifact-id] SCHEMA_ID --set RULE
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --artifact-id 값
- 스키마의 ID입니다.
- --set 값
- 호환성 규칙의 값입니다. 허용되는 값은 "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" 및 "BACKWARD_TRANSITIVE" 입니다.
IBM클라우드 ES 스키마 호환성 규칙
스키마 또는 글로벌 호환성 규칙을 표시합니다.
ibmcloud es es schema-compatibility-rule [ [--artifact-id] SCHEMA_ID | --global ] [--json]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다. --artifact-id 또는 --global 플래그를 사용합니다.
명령 옵션:
- --artifact-id 값
- 선택사항입니다. 스키마의 ID입니다.
- --global
- 선택사항입니다. 글로벌 호환성 규칙을 표시합니다.
- --json
- 선택사항입니다. 출력 형식을 JSON으로 지정합니다.
IBM클라우드 ES 스키마 호환성 규칙 업데이트
스키마 또는 전역 호환성 규칙을 변경합니다.
ibmcloud es schema-compatibility-rule-update [ [--artifact-id] SCHEMA_ID | --global ] --set RULE
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다. --artifact-id 또는 --global 플래그를 사용합니다.
명령 옵션:
- --artifact-id 값
- 선택사항입니다. 스키마의 ID입니다.
- --global
- 선택사항입니다. 글로벌 호환성 규칙을 변경합니다.
- --set 값
- 호환성 규칙의 값입니다. 허용되는 값은 "NONE", "FULL", "FULL_TRANSITIVE", "FORWARD", "FORWARD_TRANSITIVE", "BACKWARD" 및 "BACKWARD_TRANSITIVE" 입니다.
ibmcloud es 스키마 호환성 규칙 삭제
스키마 호환성 규칙을 삭제합니다.
ibmcloud es schema-compatibility-rule-delete [--artifact-id] SCHEMA_ID [--force]
전제조건: 이 조작은 엔터프라이즈 플랜에만 스키마 사용 및 관리를 위한 스키마 레지스트리가 포함되므로 엔터프라이즈 인스턴스에서만 허용됩니다.
명령 옵션:
- --artifact-id 값
- 스키마의 ID입니다.
- --force
- 선택사항입니다. 확인 없이 호환성 규칙을 삭제합니다.