이 페이지는 공개 계약에서 생성하며 설명은 원문(한국어) 그대로 표시합니다.
stly services apis#
Service의 제공 API 목록
- HTTP 요청:
GET /api/services/{id}/apis - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: base_urls, created_at, description, handle, id, name, security, summary, updated_at |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services apis 00000000-0000-0000-0000-000000000001 --q "검색어"stly services cassandra-tables#
Service의 직접 연결 Cassandra Table 목록
- HTTP 요청:
GET /api/services/{id}/cassandra-tables - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: database_id, database_name, engine, id, name, summary |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services cassandra-tables 00000000-0000-0000-0000-000000000001 --q "검색어"stly services collections#
Service의 직접 연결 Collection 목록
- HTTP 요청:
GET /api/services/{id}/collections - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: database_id, database_name, engine, id, name, summary |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services collections 00000000-0000-0000-0000-000000000001 --q "검색어"stly services create#
Service 생성
- HTTP 요청:
POST /api/services - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 예
- 입력 JSON(
--input) 필수
입력 JSON 구조는 stly schema services create로 확인합니다.
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--input | string | 예 | JSON 원문 파일 또는 stdin(-) |
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: created_at, description, handle, id, name, status, summary, updated_at |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services create --input input.jsonstly services databases#
Service의 직접 연결 Database 목록
- HTTP 요청:
GET /api/services/{id}/databases - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: database_id, database_name, engine, id, name, summary |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services databases 00000000-0000-0000-0000-000000000001 --q "검색어"stly services delete#
Service 삭제
- HTTP 요청:
DELETE /api/services/{id} - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 예
--if-match필수
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--if-match | string | 예 | 상세 GET에서 얻은 단일 strong ETag |
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services delete 00000000-0000-0000-0000-000000000001 --if-match '"상세 GET의 ETag"'stly services get#
Service 상세 조회
- HTTP 요청:
GET /api/services/{id} - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: created_at, description, handle, id, name, status, summary, updated_at |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services get 00000000-0000-0000-0000-000000000001stly services kafka-usages#
Service를 참조하는 Kafka 사용 설명 목록
- HTTP 요청:
GET /api/services/{id}/kafka-usages - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: application_name, cluster_id, cluster_name, consumer_group, description, direction, topic_id, topic_name, usage_id |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services kafka-usages 00000000-0000-0000-0000-000000000001 --q "검색어"stly services key-patterns#
Service의 직접 연결 Key Pattern 목록
- HTTP 요청:
GET /api/services/{id}/key-patterns - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: database_id, database_name, engine, id, name, summary |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services key-patterns 00000000-0000-0000-0000-000000000001 --q "검색어"stly services list#
Service 목록 조회
- HTTP 요청:
GET /api/services - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: created_at, description, handle, id, name, status, summary, updated_at |
--handle | string | 아니요 | Web 주소 이름 정확 일치 필터. 앞뒤 공백 제거·소문자 정규화 후 비교하며 결과는 최대 1건 |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services list --q "검색어"stly services repositories#
Service의 연결 Repository 목록
- HTTP 요청:
GET /api/services/{id}/repositories - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: created_at, description, external_identity, git_url, handle, id, name, summary, updated_at |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services repositories 00000000-0000-0000-0000-000000000001 --q "검색어"stly services repository-links add#
Service 연결 Repository 하나 추가(GET 후 PUT)
- HTTP 요청:
PUT /api/services/{id}/repository-links - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 예
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--repository | string | 예 | 추가·제거할 Repository ID 하나 |
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: repository_ids, service_id, updated_at |
--if-match | string | 아니요 | 선택 기준 strong ETag. GET 토큰과 다르면 쓰기 전에 중단. 생략 시 과거 조회 시점은 보호하지 않음 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
동작
- 상세 GET 1회로 현재 수정 가능 필드·연결 집합과 strong ETag 조회
- 선택 --if-match와 GET ETag가 다르면 쓰기 전 중단. 생략 시 실행 직전 GET 이후 변경만 보호하며 과거 조회 시점은 보호하지 않음
- 지정 필드·ID만 변경하고 나머지는 보존한 전체 PUT 1회. 연결 추가·제거의 no-op은 PUT 생략
- 412·쓰기 결과 불명 후 자동 재조회·재전송 없음. 성공 후 새 ETag를 위한 자동 GET 없음
- dry-run은 HTTP·설정·credential 접근 없이 계획만 표시하며 현재 값·최종 본문·권한·no-op 여부는 미확인
예시
stly services repository-links add 00000000-0000-0000-0000-000000000001 --repository 00000000-0000-0000-0000-000000000001stly services repository-links get#
Service 연결 Repository 집합 조회
- HTTP 요청:
GET /api/services/{id}/repository-links - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: repository_ids, service_id, updated_at |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services repository-links get 00000000-0000-0000-0000-000000000001stly services repository-links remove#
Service 연결 Repository 하나 제거(GET 후 PUT)
- HTTP 요청:
PUT /api/services/{id}/repository-links - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 예
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--repository | string | 예 | 추가·제거할 Repository ID 하나 |
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: repository_ids, service_id, updated_at |
--if-match | string | 아니요 | 선택 기준 strong ETag. GET 토큰과 다르면 쓰기 전에 중단. 생략 시 과거 조회 시점은 보호하지 않음 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
동작
- 상세 GET 1회로 현재 수정 가능 필드·연결 집합과 strong ETag 조회
- 선택 --if-match와 GET ETag가 다르면 쓰기 전 중단. 생략 시 실행 직전 GET 이후 변경만 보호하며 과거 조회 시점은 보호하지 않음
- 지정 필드·ID만 변경하고 나머지는 보존한 전체 PUT 1회. 연결 추가·제거의 no-op은 PUT 생략
- 412·쓰기 결과 불명 후 자동 재조회·재전송 없음. 성공 후 새 ETag를 위한 자동 GET 없음
- dry-run은 HTTP·설정·credential 접근 없이 계획만 표시하며 현재 값·최종 본문·권한·no-op 여부는 미확인
예시
stly services repository-links remove 00000000-0000-0000-0000-000000000001 --repository 00000000-0000-0000-0000-000000000001stly services repository-links update#
Service 연결 Repository 집합 전체 교체
- HTTP 요청:
PUT /api/services/{id}/repository-links - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 예
- 입력 JSON(
--input) 필수 --if-match필수
입력 JSON 구조는 stly schema services repository-links update로 확인합니다.
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--if-match | string | 예 | 상세 GET에서 얻은 단일 strong ETag |
--input | string | 예 | JSON 원문 파일 또는 stdin(-) |
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: repository_ids, service_id, updated_at |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services repository-links update 00000000-0000-0000-0000-000000000001 --input input.json --if-match '"상세 GET의 ETag"'stly services systems#
Service의 소속 System 조회
- HTTP 요청:
GET /api/services/{id}/systems - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: description, id, inclusion, kind, name, summary |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--scope | string | 아니요 | direct 또는 recursive 구성 범위 값: direct, recursive |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services systems 00000000-0000-0000-0000-000000000001 --q "검색어"stly services tables#
Service의 직접 연결 Table 목록
- HTTP 요청:
GET /api/services/{id}/tables - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 아니요
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: database_id, database_name, engine, id, name, summary |
--page | string | 아니요 | 1 이상 정수. page·per-page 중 하나라도 있으면 페이지 모드 |
--per-page | string | 아니요 | 1~500 정수, 생략 시 100 |
--q | string | 아니요 | name 필드의 대소문자 구분 리터럴 부분 일치 검색. summary·description·본문은 검색하지 않으며 정규식·와일드카드를 지원하지 않습니다 |
--sort | string | 아니요 | 리소스 기본 필드명 또는 - 접두 역순만 허용 |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services tables 00000000-0000-0000-0000-000000000001 --q "검색어"stly services update#
Service 수정
- HTTP 요청:
PUT /api/services/{id} - 인증 모드: Agent 토큰, User 세션
- 기록 변경: 예
- 입력 JSON(
--input) 필수 --if-match필수
입력 JSON 구조는 stly schema services update로 확인합니다.
인수
id: ID
옵션
| 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
--if-match | string | 예 | 상세 GET에서 얻은 단일 strong ETag |
--input | string | 예 | JSON 원문 파일 또는 stdin(-) |
--fields | string | 아니요 | 응답 최상위 필드, 쉼표로 구분 값: created_at, description, handle, id, name, status, summary, updated_at |
공통 옵션: --server, --env-file, --timeout, --auth-mode, --dry-run
예시
stly services update 00000000-0000-0000-0000-000000000001 --input input.json --if-match '"상세 GET의 ETag"'