stly

stly kafka-topics

On this page

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

stly kafka-topics create#

Kafka Topic 생성

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

Check the input JSON structure with stly schema kafka-topics create.

Options

Name	Type	Required	Description
`--cluster`	`string`	Yes	부모 Kafka Cluster ID
`--input`	`string`	Yes	JSON 원문 파일 또는 stdin(-)
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `cleanup_policy`, `cluster_id`, `created_at`, `description`, `external_references`, `id`, `message_definitions`, `name`, `partition_count`, `retention_order_description`, `summary`, `time_retention_ms`, `updated_at`, `usages`

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

Example

stly kafka-topics create --cluster 00000000-0000-0000-0000-000000000001 --input input.json

stly kafka-topics delete#

Kafka Topic 삭제

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

Arguments

id: ID

Options

Name	Type	Required	Description
`--if-match`	`string`	Yes	상세 GET에서 얻은 단일 strong ETag
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분

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

Example

stly kafka-topics delete 00000000-0000-0000-0000-000000000001 --if-match '"상세 GET의 ETag"'

stly kafka-topics get#

Kafka Topic 상세 조회

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

Arguments

id: ID

Options

Name	Type	Required	Description
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `cleanup_policy`, `cluster_id`, `created_at`, `description`, `external_references`, `id`, `message_definitions`, `name`, `partition_count`, `retention_order_description`, `summary`, `time_retention_ms`, `updated_at`, `usages`

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

Example

stly kafka-topics get 00000000-0000-0000-0000-000000000001

stly kafka-topics list#

Kafka Topic 목록 조회

HTTP request: GET /api/kafka-topics
Authentication modes: Agent token, User session
Changes records: No

Options

Name	Type	Required	Description
`--cluster`	`string`	No	부모 Kafka Cluster ID
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `cleanup_policy`, `cluster_id`, `created_at`, `description`, `external_references`, `id`, `message_definitions`, `name`, `partition_count`, `retention_order_description`, `summary`, `time_retention_ms`, `updated_at`, `usages`
`--page`	`string`	No	1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드
`--per-page`	`string`	No	1~500 정수, 생략 시 100
`--q`	`string`	No	name·summary·description 필드 중 하나의 대소문자 구분 리터럴 부분 일치 검색. 본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다
`--sort`	`string`	No	리소스 기본 필드명 또는 - 접두 역순만 허용

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

Example

stly kafka-topics list --cluster 00000000-0000-0000-0000-000000000001 --q "검색어"

stly kafka-topics update#

Kafka Topic 수정

HTTP request: PUT /api/kafka-topics/{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 kafka-topics update.

Arguments

id: ID

Options

Name	Type	Required	Description
`--if-match`	`string`	Yes	상세 GET에서 얻은 단일 strong ETag
`--input`	`string`	Yes	JSON 원문 파일 또는 stdin(-)
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분 Values: `cleanup_policy`, `cluster_id`, `created_at`, `description`, `external_references`, `id`, `message_definitions`, `name`, `partition_count`, `retention_order_description`, `summary`, `time_retention_ms`, `updated_at`, `usages`

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

Example

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

stly kafka-topics validate#

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

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

Check the input JSON structure with stly schema kafka-topics validate --operation create|update.

Arguments

id: ID

Options

Name	Type	Required	Description
`--input`	`string`	Yes	JSON 원문 파일 또는 stdin(-)
`--operation`	`string`	Yes	검증할 작업 종류. 생성 후보는 create, 수정 후보는 update Values: `create`, `update`
`--cluster`	`string`	No	부모 Kafka Cluster ID
`--fields`	`string`	No	응답 최상위 필드, 쉼표로 구분
`--if-match`	`string`	No	상세 GET에서 얻은 단일 strong ETag

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

Behavior

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

Example

stly kafka-topics validate --operation create --cluster 00000000-0000-0000-0000-000000000001 --input input.json

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