Skip to content
Structly Docs
한국어

stly

stly messaging-clusters

On this page

This page is generated from the public contract. Descriptions are shown in the original Korean.

stly messaging-clusters create#

Kafka Cluster 생성

  • HTTP request: POST /api/messaging-clusters
  • Authentication modes: Agent token, User session
  • Changes records: Yes
  • Input JSON (--input) required

Check the input JSON structure with stly schema messaging-clusters create.

Options

NameTypeRequiredDescription
--inputstringYesJSON 원문 파일 또는 stdin(-)
--fieldsstringNo응답 최상위 필드, 쉼표로 구분
Values: created_at, description, environment_description, external_references, handle, id, name, product, summary, updated_at

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly messaging-clusters create --input input.json

stly messaging-clusters delete#

Kafka Cluster 삭제

  • HTTP request: DELETE /api/messaging-clusters/{id}
  • Authentication modes: Agent token, User session
  • Changes records: Yes
  • --if-match required

Arguments

  • id: ID

Options

NameTypeRequiredDescription
--if-matchstringYes상세 GET에서 얻은 단일 strong ETag
--fieldsstringNo응답 최상위 필드, 쉼표로 구분

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly messaging-clusters delete 00000000-0000-0000-0000-000000000001 --if-match '"상세 GET의 ETag"'

stly messaging-clusters get#

Kafka Cluster 상세 조회

  • HTTP request: GET /api/messaging-clusters/{id}
  • Authentication modes: Agent token, User session
  • Changes records: No

Arguments

  • id: ID

Options

NameTypeRequiredDescription
--fieldsstringNo응답 최상위 필드, 쉼표로 구분
Values: created_at, description, environment_description, external_references, handle, id, name, product, summary, updated_at

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly messaging-clusters get 00000000-0000-0000-0000-000000000001

stly messaging-clusters list#

Kafka Cluster 목록 조회

  • HTTP request: GET /api/messaging-clusters
  • Authentication modes: Agent token, User session
  • Changes records: No

Options

NameTypeRequiredDescription
--fieldsstringNo응답 최상위 필드, 쉼표로 구분
Values: created_at, description, environment_description, external_references, handle, id, name, product, summary, updated_at
--handlestringNoWeb 주소 이름 정확 일치 필터. 앞뒤 공백 제거·소문자 정규화 후 비교하며 결과는 최대 1건
--pagestringNo1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드
--per-pagestringNo1~500 정수, 생략 시 100
--qstringNoname·summary·description 필드 중 하나의 대소문자 구분 리터럴 부분 일치 검색. 본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다
--sortstringNo리소스 기본 필드명 또는 - 접두 역순만 허용

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly messaging-clusters list --q "검색어"

stly messaging-clusters update#

Kafka Cluster 수정

  • HTTP request: PUT /api/messaging-clusters/{id}
  • Authentication modes: Agent token, User session
  • Changes records: Yes
  • Input JSON (--input) required
  • --if-match required

Check the input JSON structure with stly schema messaging-clusters update.

Arguments

  • id: ID

Options

NameTypeRequiredDescription
--if-matchstringYes상세 GET에서 얻은 단일 strong ETag
--inputstringYesJSON 원문 파일 또는 stdin(-)
--fieldsstringNo응답 최상위 필드, 쉼표로 구분
Values: created_at, description, environment_description, external_references, handle, id, name, product, summary, updated_at

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Example

stly messaging-clusters update 00000000-0000-0000-0000-000000000001 --input input.json --if-match '"상세 GET의 ETag"'

stly messaging-clusters validate#

Kafka Cluster 생성·수정 후보 사전 검증(저장 없음)

  • HTTP request: --operation create POST /api/messaging-clusters/validate, --operation update PUT /api/messaging-clusters/{id}/validate
  • Authentication modes: Agent token, User session
  • Changes records: No
  • Input JSON (--input) required

Check the input JSON structure with stly schema messaging-clusters validate --operation create|update.

Arguments

  • id: ID

Options

NameTypeRequiredDescription
--inputstringYesJSON 원문 파일 또는 stdin(-)
--operationstringYes검증할 작업 종류. 생성 후보는 create, 수정 후보는 update
Values: create, update
--fieldsstringNo응답 최상위 필드, 쉼표로 구분
--if-matchstringNo상세 GET에서 얻은 단일 strong ETag

Common options: --server, --env-file, --timeout, --auth-mode, --dry-run

Behavior

  1. 실제 서버를 호출해 입력·참조·중복·If-Match를 검사하며 저장하지 않습니다. 도메인 규칙은 서버가 판단합니다.
  2. --operation create: 대상 id·If-Match 금지. update: 대상 id·단일 strong If-Match 필수, 부모 옵션 금지
  3. --dry-run: credential 접근·HTTP 요청·파일 변경 없이 요청 계획만 출력
  4. 성공은 관찰 시점의 유효성으로 저장 성공·ID 예약·충돌 방지를 보장하지 않습니다. 자동 저장·자동 재시도하지 않습니다.
  5. 지원: Kafka Cluster. 현재 Organization의 이름 중복 검사

Example

stly messaging-clusters validate --operation create --input input.json
stly messaging-clusters validate 00000000-0000-0000-0000-000000000001 --operation update --input input.json --if-match '"상세 GET의 ETag"'