생성¶
POST /api/v1/workspace/create
개요¶
워크스페이스를 생성하고 소유자를 지정하며 수집 Token, 스토리지 및 기본 리소스를 초기화합니다.
호출 전 및 사용 단계¶
사용 전에 대상 사이트의 스토리지 엔진과 워크스페이스 기본 버전이 구성되어 있는지 확인하고, 로그인할 수 있는 소유자 계정을 선택합니다. 최소 요청에는 name과 ownerUuid만 필요하며, 나머지는 사이트 기본값을 우선 사용합니다. 성공 후 content.wsInfo.uuid를 저장한 다음 상세/인덱스 템플릿 조회로 최종 구성을 확인합니다. 이 작업은 이름 기준 중복 제거를 수행하지 않으며 멱등 키가 없습니다. 반복 제출하면 여러 워크스페이스가 생성될 수 있습니다. 계정 워크스페이스, 기본 Token, 채널, 기본 온콜 정책 등의 초기화는 여러 단계를 거치며, 데이터베이스가 먼저 커밋된 후 리소스 서비스를 호출할 수 있습니다. HTTP 200과 빈 문제 표시가 모든 다운스트림 데이터베이스 생성이 완료되었음을 보장하지는 않습니다.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 예제와 일치해야 하며, 생략하고 이 알고리즘을 계속 사용할 수는 없습니다. 예: v20240417가져오기 또는 입력 방법: 이 페이지의 원본 경로 및 요청 본문 서명 알고리즘에 맞춰 입력합니다. |
|
| X-Df-Access-Key | string | Y | 여기의 일곱 항목은 모두 쓰기 작업이며 External 쓰기 권한이 필요합니다. 예: <external-access-key>가져오기 또는 입력 방법: 사이트 관리자가 w 권한이 있는 External API AK를 할당합니다. 워크스페이스 OpenAPI Key가 아닙니다. |
| X-Df-Nonce | string | Y | 매번 다시 전송할 때 이 값과 서명도 갱신합니다. 예: 97d275ee9f774315a7885ba7347acbd9가져오기 또는 입력 방법: 요청마다 uuid.uuid4().hex를 다시 생성합니다. |
| X-Df-Signature | string | Y | 대문자 메서드, nonce, 원본 전체 경로, timestamp 및 원본 UTF-8 요청 본문을 공백으로 연결한 뒤 HMAC-SHA256 hex 다이제스트를 계산합니다. 예: <hmac-sha256-hex>가져오기 또는 입력 방법: 함께 제공된 SK로 External API 서명 인증 및 아래 Python 템플릿에 따라 계산합니다. |
| X-Df-Timestamp | string | Y | 예제의 고정 시간을 재사용할 수 없으며, 사이트의 서명 유효 시간 범위 내에 있어야 합니다. 예: 1785427200가져오기 또는 입력 방법: 전송 시 str(int(time.time()))로 현재 Unix 초를 생성합니다. |
Body 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| brandKey | string | 선택 사항입니다. 생략하거나 비어 있으면 사이트 기본 브랜드로 대체되며, 값이 있으면 사이트에서 허용된 집합에 속해야 하고 null일 수 없습니다. null 허용: False 예: guance가져오기 또는 입력 방법: 사이트 관리자에게 허용된 브랜드 식별자를 받습니다. |
|
| desc | string | 선택 설명입니다. 생략하면 빈 문자열이 되며, 빈 문자열을 명시적으로 전달할 수 있습니다. null이 허용된다고 선언되어 있지만 저장 컬럼은 비어 있을 수 없으므로 null 전달을 피하십시오. 빈 문자열 허용: True null 허용: True 예: 接口文档演示工作空间가져오기 또는 입력 방법: 해당 워크스페이스의 용도를 입력합니다. |
|
| durationSet | object | 선택 객체이며, 값은 일수 뒤에 소문자 d를 붙입니다. 생략하면 사이트의 해당 워크스페이스 버전 기본 보존 기간을 사용하며, 누락된 유형은 기본 설정에서 보완됩니다. 생성 프로세스는 모든 사용자 지정 보존 기간 범위를 일괄 검사하지 않으므로, 확인된 사이트의 선택 가능한 값을 사용해야 하며, 성공이 모든 다운스트림 데이터베이스 생성 완료를 의미하지도 않습니다. 예: {"logging": "7d"}가져오기 또는 입력 방법: 먼저 인덱스 템플릿 목록에서 현재 durationSet, esIndexMerged 및 datastore를 가져온 뒤 실제 버전/엔진에 맞게 선택합니다. |
|
| durationSet.apm | string | 병합 인덱스의 APM 데이터에 대한 표준 보존 기간이며, 생성 시 최종 인덱스 모드가 해당 키를 지원하는 경우에만 사용합니다. 제공하지 않거나 빈 문자열이면 사이트 기본값으로 대체될 수 있습니다. null 허용: False 예: 7d가져오기 또는 입력 방법: 현재 워크스페이스 또는 동일 버전 워크스페이스의 인덱스 템플릿 목록에서 해당 필드 값을 가져온 뒤 사이트 허용 범위에 맞게 조정합니다. |
|
| durationSet.backup_log | string | 백업 로그의 표준 보존 기간이며, 생성 시 최종 인덱스 모드가 해당 키를 지원하는 경우에만 사용합니다. 제공하지 않거나 빈 문자열이면 사이트 기본값으로 대체될 수 있습니다. null 허용: False 예: 7d가져오기 또는 입력 방법: 현재 워크스페이스 또는 동일 버전 워크스페이스의 인덱스 템플릿 목록에서 해당 필드 값을 가져온 뒤 사이트 허용 범위에 맞게 조정합니다. |
|
| durationSet.keyevent | string | 이벤트의 표준 보존 기간이며, 생성 시 최종 인덱스 모드가 해당 키를 지원하는 경우에만 사용합니다. 제공하지 않거나 빈 문자열이면 사이트 기본값으로 대체될 수 있습니다. null 허용: False 예: 7d가져오기 또는 입력 방법: 현재 워크스페이스 또는 동일 버전 워크스페이스의 인덱스 템플릿 목록에서 해당 필드 값을 가져온 뒤 사이트 허용 범위에 맞게 조정합니다. |
|
| durationSet.logging | string | 기본 로그의 표준 보존 기간이며, 생성 시 최종 인덱스 모드가 해당 키를 지원하는 경우에만 사용합니다. 제공하지 않거나 빈 문자열이면 사이트 기본값으로 대체될 수 있습니다. null 허용: False 예: 7d가져오기 또는 입력 방법: 현재 워크스페이스 또는 동일 버전 워크스페이스의 인덱스 템플릿 목록에서 해당 필드 값을 가져온 뒤 사이트 허용 범위에 맞게 조정합니다. |
|
| durationSet.network | string | 네트워크 데이터의 표준 보존 기간이며, 생성 시 최종 인덱스 모드가 해당 키를 지원하는 경우에만 사용합니다. 제공하지 않거나 빈 문자열이면 사이트 기본값으로 대체될 수 있습니다. null 허용: False 예: 7d가져오기 또는 입력 방법: 현재 워크스페이스 또는 동일 버전 워크스페이스의 인덱스 템플릿 목록에서 해당 필드 값을 가져온 뒤 사이트 허용 범위에 맞게 조정합니다. |
|
| durationSet.rp | string | 메트릭 시계열의 표준 보존 기간이며, 생성 시 최종 인덱스 모드가 해당 키를 지원하는 경우에만 사용합니다. 제공하지 않거나 빈 문자열이면 사이트 기본값으로 대체될 수 있습니다. null 허용: False 예: 7d가져오기 또는 입력 방법: 현재 워크스페이스 또는 동일 버전 워크스페이스의 인덱스 템플릿 목록에서 해당 필드 값을 가져온 뒤 사이트 허용 범위에 맞게 조정합니다. |
|
| durationSet.rum | string | 실제 사용자 모니터링(RUM)의 표준 보존 기간이며, 생성 시 최종 인덱스 모드가 해당 키를 지원하는 경우에만 사용합니다. 제공하지 않거나 빈 문자열이면 사이트 기본값으로 대체될 수 있습니다. null 허용: False 예: 7d가져오기 또는 입력 방법: 현재 워크스페이스 또는 동일 버전 워크스페이스의 인덱스 템플릿 목록에서 해당 필드 값을 가져온 뒤 사이트 허용 범위에 맞게 조정합니다. |
|
| durationSet.security | string | 점검/보안 데이터의 표준 보존 기간이며, 생성 시 최종 인덱스 모드가 해당 키를 지원하는 경우에만 사용합니다. 제공하지 않거나 빈 문자열이면 사이트 기본값으로 대체될 수 있습니다. null 허용: False 예: 7d가져오기 또는 입력 방법: 현재 워크스페이스 또는 동일 버전 워크스페이스의 인덱스 템플릿 목록에서 해당 필드 값을 가져온 뒤 사이트 허용 범위에 맞게 조정합니다. |
|
| durationSet.tracing | string | 애플리케이션 트레이스의 표준 보존 기간이며, 생성 시 최종 인덱스 모드가 해당 키를 지원하는 경우에만 사용합니다. 제공하지 않거나 빈 문자열이면 사이트 기본값으로 대체될 수 있습니다. null 허용: False 예: 7d가져오기 또는 입력 방법: 현재 워크스페이스 또는 동일 버전 워크스페이스의 인덱스 템플릿 목록에서 해당 필드 값을 가져온 뒤 사이트 허용 범위에 맞게 조정합니다. |
|
| enableRumMultipleTable | integer | 선택 정수 0/1 또는 null입니다. 현재 생성 로직은 이 입력 매개변수를 무시하고 실제로는 사이트의 enableRumMultipleTable 기본 설정을 사용하며, 리포지토리 기본값은 활성화입니다. null 허용: True 선택 가능한 값: [0, 1] 예: 1가져오기 또는 입력 방법: 새 워크스페이스의 실제 값은 사이트 관리자가 구성하며, 생성 후 수정 인터페이스를 통해 조정할 수 있습니다. |
|
| esIndexMerged | boolean | 선택 사항입니다. 생략하면 사이트 설정을 사용하며 리포지토리 기본값은 false입니다. 사용자 지정 로그 스토리지 인스턴스를 명시하는 경우 true와 함께 사용할 수 없으며, SLS/Beaver에서는 최종적으로 false가 강제됩니다. null 허용: False 예: false가져오기 또는 입력 방법: 대상 스토리지 엔진과 데이터 유형 격리 요구 사항에 따라 선택하며, 사용자 지정 로그 인스턴스에는 false를 권장합니다. |
|
| isOpenCustomMappingRule | boolean | 선택 부울 값입니다. 생략하면 사이트 설정을 사용하며 리포지토리 기본값은 false이고 null일 수 없습니다. null 허용: False 예: false가져오기 또는 입력 방법: 조직의 사용자 지정 필드 매핑 필요에 따라 선택합니다. |
|
| isOpenLogMultipleIndex | boolean | 선택 부울 값입니다. 생략하면 사이트 설정을 사용하며 리포지토리 기본값은 true이고 SLS/Beaver에서는 활성화가 강제됩니다. false는 신규 생성만 제한하며 기존 인덱스를 삭제하지 않습니다. null 허용: False 예: true가져오기 또는 입력 방법: 사용자 지정 로그 인덱스 생성을 허용해야 할 때 true로 설정합니다. |
|
| language | string | 선택 사항이며 생략하면 zh입니다. 빈 문자열은 그대로 저장되며 자동으로 zh가 되지 않습니다. null 허용으로 선언되어 있지만 NOT NULL 저장 제약으로 저장이 실패할 수 있으므로 열거형 값을 명시적으로 사용하는 것이 좋습니다. 빈 문자열 허용: True null 허용: True 선택 가능한 값: ['zh', 'en', 'zh-hant', 'id', 'ja', 'ko'] 예: zh가져오기 또는 입력 방법: 워크스페이스 사용자에 따라 zh, en, zh-hant, id, ja, ko 중 하나를 선택합니다. |
|
| leftWildcard | boolean | 선택 부울 값입니다. 생략하면 사이트 설정을 사용하며 리포지토리 기본값은 false입니다. null 허용: False 예: false가져오기 또는 입력 방법: 별표로 시작하는 와일드카드 검색이 필요할 때 true로 설정하되 실제 쿼리 성능을 함께 평가하십시오. |
|
| logMultipleIndexCount | int | 선택 정수입니다. 생략하면 사이트 기본 수량을 사용하며, 다중 인덱스가 활성화된 경우에만 수량 설정을 생성하는 데 사용됩니다. SLS/Beaver에서는 음수일 수 없고 0은 수량 제한 없음을 의미합니다. 일반 스토리지에서는 양수를 사용해야 하며 null일 수 없습니다. null 허용: False 예: 30가져오기 또는 입력 방법: 조직의 다중 인덱스 사용량에 따라 선택하며 리포지토리 기본값은 30이고 사이트에서 재정의할 수 있습니다. |
|
| loggingCutSize | int | 선택 정수이며 단위는 바이트입니다. 생략하면 사이트 설정을 사용하고 리포지토리 기본값은 10240입니다. 0 등 빈 값은 스토리지 엔진에 따라 기본값으로 대체되며, 분할을 끈다는 의미가 아닙니다. null 허용: False 예: 10240가져오기 또는 입력 방법: 사이트 로그 크기 요구 사항에 따라 바이트 수를 지정하며, 일반적으로 사이트 기본값을 재사용합니다. |
|
| maxSearchResultCount | integer | 선택 사항입니다. 0은 여기에서 추가 결과 개수 상한을 설정하지 않음을 의미합니다. 생략하면 사이트 설정을 사용하며 리포지토리 기본값은 0입니다. 페이지당 개수와 같지 않으며 null일 수 없습니다. null 허용: False 예: 0가져오기 또는 입력 방법: 클라이언트가 감당할 수 있는 쿼리 결과 수에 따라 선택하며, 음수가 아닌 정수를 권장합니다. |
|
| name | string | Y | 필수 이름입니다. 선언된 최대 길이는 256자이지만 현재 데이터베이스 컬럼은 128자이므로, 긴 값으로 인한 저장 실패를 피하려면 128자 이내로 유지하는 것이 좋습니다. 이름은 멱등 키가 아닙니다. null 허용: False 최대 길이: 256 예: API示例空间가져오기 또는 입력 방법: 비즈니스 담당자가 새 워크스페이스에 식별하기 쉬운 이름을 지정합니다. |
| ownerUuid | string | Y | 필수 계정 UUID이며 필드 이름은 ownerUuid입니다. 삭제되었거나 존재하지 않는 계정은 거부됩니다. 현재 검증은 비활성화된 계정도 허용하지만, 비활성화된 계정은 정상적으로 로그인할 수 없습니다. 성공하면 해당 계정에 Owner 역할이 부여됩니다. Owner가 없는 워크스페이스가 생성되지 않도록 빈 문자열을 전달하지 마십시오. 빈 문자열 허용: False 예: acnt_example001가져오기 또는 입력 방법: 계정 목록의 content.data[].uuid에서 이 워크스페이스의 소유자를 선택하며, 정상적으로 활성화된 계정을 선택하는 것이 좋습니다. |
| storageTypeUUID | string | 선택 사항입니다. 생략하거나 null 또는 빈 문자열이면 사이트 기본 로그 스토리지를 사용합니다. 명시적으로 지정할 때 esIndexMerged=true와 함께 사용할 수 없습니다. 이 External 진입점에는 datastoreCfg 자격 증명 매개변수가 없으므로, 추가 자격 증명이 필요한 사용자 지정 SLS 인스턴스를 이 진입점에서 선택해서는 안 됩니다. null 허용: True 예: esinst_example001가져오기 또는 입력 방법: 사이트 관리 백엔드의 스토리지 엔진 설정에서 활성 로그 스토리지 인스턴스 UUID를 가져오며, 관리자에게 제공을 요청할 수 있습니다. datastore의 엔진 이름이 아닙니다. |
매개변수 추가 설명¶
w 권한이 있는 사이트 수준 External API 자격 증명을 사용합니다. 인증 방식은 External API 서명 인증을 참조하십시오. 예제는 v20240417에 따라 서명을 계산하며, 서명과 전송에 동일한 경로, Query 및 원본 요청 본문을 사용합니다. 모든 예제는 데모 값이므로 실행 전에 실제 대상으로 교체해야 합니다. 쓰기 요청이 시간 초과되거나 500이 반환되면 먼저 현재 상태를 조회하고 확인한 후 재시도 여부를 결정하십시오.
요청 예제¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 대상 사이트 주소 및 관리자가 할당한 External API AK/SK로 교체합니다.
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'POST'
path = '/api/v1/workspace/create'
query = {}
data = {'name': 'API示例空间', 'ownerUuid': 'acnt_example001', 'desc': '接口文档演示工作空间', 'esIndexMerged': False, 'isOpenLogMultipleIndex': True, 'language': 'zh'}
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
응답¶
HTTP 200, application/json, 통합 응답 래퍼입니다. 비즈니스 결과는 content에 있으며, External은 declaration을 자동으로 주입하지 않습니다. 워크스페이스 객체의 declaration은 워크스페이스 자체에 저장된 필드입니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.accountInfo | 문자열 배열 | 새 워크스페이스에 참여한 계정 UUID입니다. 이 공개 인터페이스에는 일반적으로 지정된 ownerUuid만 포함됩니다. |
| content.wsInfo.id | integer | 사이트 내 레코드 일련번호입니다. 후속 호출에는 uuid를 사용합니다. |
| content.wsInfo.uuid | string | 워크스페이스 UUID. |
| content.wsInfo.status | integer | 0은 정상, 3은 삭제 표시됨입니다. 삭제 응답 스냅샷은 3입니다. |
| content.wsInfo.creator | string | 생성 주체 식별자이며, External 생성 시 일반적으로 sys입니다. |
| content.wsInfo.updator | string | 최근 수정 주체이며 수정되지 않은 경우 비어 있을 수 있습니다. |
| content.wsInfo.createAt | integer | 생성 시간, Unix 초. |
| content.wsInfo.deleteAt | integer | 삭제 시간, Unix 초, 삭제되지 않은 경우 일반적으로 -1. |
| content.wsInfo.updateAt | integer | 수정 시간, Unix 초, 아직 수정되지 않은 경우 일반적으로 -1. |
| content.wsInfo.name | string | 워크스페이스 표시 이름. |
| content.wsInfo.token | string | 워크스페이스 기본 수집 Token입니다. 자격 증명으로 저장되며 External AK/SK로 사용할 수 없습니다. 예제에는 자리표시자 값이 사용됩니다. |
| content.wsInfo.cliToken | string | 워크스페이스 CLI 자격 증명이며 자격 증명으로 저장됩니다. 예제에는 실제 값이 포함되지 않습니다. |
| content.wsInfo.dbUUID | string | 메트릭 데이터베이스 레코드 UUID. |
| content.wsInfo.esInstanceUUID | string | 실제 로그 스토리지 인스턴스 UUID. |
| content.wsInfo.dashboardUUID | string | 워크스페이스 기본 뷰 식별자이며, 설정되지 않은 경우 비어 있습니다. |
| content.wsInfo.exterId | string | 외부 시스템 워크스페이스 식별자이며 일반적으로 비어 있습니다. 이 페이지에서 쓸 수 있는 필드가 아닙니다. |
| content.wsInfo.rpName | string | 메트릭 보존 정책의 내부 별칭입니다. durationSet.rp를 대신하는 데 사용하지 마십시오. |
| content.wsInfo.desc | string | 워크스페이스 설명. |
| content.wsInfo.durationSet | object 또는 null | 데이터 유형별로 저장된 표준 저장 기간입니다. 키는 엔진, 버전 및 인덱스 병합 상태에 따라 달라지며 값은 예를 들어 7d입니다. |
| content.wsInfo.storagePolicy | object 또는 null | 데이터 유형별로 저장된 장기 스토리지 정책입니다. 여기서 장기 정책은 표준 durationSet과 구분됩니다. |
| content.wsInfo.datastore | object 또는 null | 데이터 유형별로 저장된 실제 스토리지 엔진입니다. 예: metric=guancedb, logging=doris. |
| content.wsInfo.lastDqlDataCheckTime | object 또는 null | 데이터 유형별로 기록된 최근 DQL 데이터 검사 정보입니다. 시스템이 유지 관리하는 동적 객체입니다. |
| content.wsInfo.declaration | object 또는 null | 워크스페이스 자체의 조직 및 비즈니스 선언이며 organization, business를 포함할 수 있습니다. 이는 워크스페이스 컬럼이며 External 공통 응답에 자동 주입되는 필드가 아닙니다. |
| content.wsInfo.esIndexSettings | object 또는 null | 데이터 유형별로 저장된 인덱스 설정 객체입니다. 빈 객체는 워크스페이스 수준 사용자 지정 템플릿이 없음을 의미하며, 다운스트림에 기본 템플릿이 없다는 뜻은 아닙니다. |
| content.wsInfo.bindInfo | object 또는 null | 워크스페이스 브랜드 텍스트, 이메일 및 도메인 재정의 객체입니다. 키 정의는 바인딩 정보 설정을 참조하십시오. |
| content.wsInfo.versionType | string | 워크스페이스 버전입니다. 예: free, freeEdition, pay, enterprise, unlimited. 생성 시 사이트 설정을 사용하며, 이 인터페이스는 버전 입력 매개변수를 제공하지 않습니다. |
| content.wsInfo.billingState | string | 과금 상태 식별자입니다. 예: free, normal, arrearage, expired, unlimited. |
| content.wsInfo.bossStation | string | 청구 센터 노드 식별자입니다. 예: CN, SG 또는 빈 문자열. |
| content.wsInfo.brandKey | string | 워크스페이스 브랜드 식별자. |
| content.wsInfo.enablePublicDataway | integer | 공용 Dataway 허용 여부입니다. 1은 활성화, 0은 비활성화입니다. |
| content.wsInfo.isOpenLogMultipleIndex | integer 또는 boolean | 새 로그 다중 인덱스 생성을 허용하는지 여부입니다. 1은 활성화, 0은 비활성화이며 기존 인덱스는 이로 인해 삭제되지 않습니다. |
| content.wsInfo.esIndexMerged | integer | 인덱스 병합 여부입니다. 1은 병합, 0은 분할입니다. |
| content.wsInfo.supportJsonMessage | integer | JSON 메시지 지원 표시입니다. 1은 활성화, 0은 비활성화입니다. |
| content.wsInfo.isLocked | integer | 워크스페이스 잠금 표시입니다. 1은 잠김, 0은 잠기지 않음입니다. |
| content.wsInfo.lockMode | string | 잠금 모드입니다. 예: none, writeLocked. |
| content.wsInfo.lockAt | integer | 잠금 시간, Unix 초, 설정되지 않은 경우 일반적으로 -1. |
| content.wsInfo.delayDeleteAt | integer | 지연 정리 기준 시각, Unix 초, 정리 대기 프로세스에 없는 경우 일반적으로 -1. |
| content.wsInfo.inviteAudit | integer | 구성원 초대 심사 활성화 여부입니다. 1은 활성화, 0은 비활성화입니다. |
| content.wsInfo.makeResourceExceptionCode | string | 리소스 초기화 문제 표시이며 비어 있을 수 있습니다. 생성 프로세스는 content 최상위에도 최신 문제 표시를 반환합니다. |
| content.wsInfo.loggingCutSize | integer | 대용량 로그 분할 단위, 바이트. |
| content.wsInfo.language | string | 워크스페이스 언어 식별자. |
| content.wsInfo.noviceGuide | boolean | 초보자 가이드 표시. |
| content.wsInfo.timezone | string | 워크스페이스 시간대이며 설정되지 않은 경우 비어 있습니다. |
| content.wsInfo.menuStyle | string | 메뉴 스타일 식별자이며 설정되지 않은 경우 비어 있습니다. |
| content.wsInfo.tenantId | integer | 워크스페이스 테넌트 ID입니다. 생성 응답은 테넌트 ID가 생성되기 전에 스냅샷을 캡처하므로 -1일 수 있으며, 이후 상세 정보에서 최종 값을 읽어야 합니다. |
| content.wsInfo.isOpenCustomMappingRule | integer | 사용자 지정 매핑 규칙 스위치입니다. 1은 활성화, 0은 비활성화입니다. |
| content.wsInfo.enableRumMultipleTable | integer | RUM 테이블 분할 스위치입니다. 1은 활성화, 0은 비활성화입니다. |
| content.wsInfo.enableMFA | boolean | MFA를 요구하는지 여부입니다. |
| content.wsInfo.disableQueryAcceleration | integer | 쿼리 가속 비활성화 표시입니다. 1은 비활성화, 0은 비활성화하지 않음입니다. |
| content.wsInfo.disableDataWrite | integer | 쓰기 비활성화 표시입니다. 1은 비활성화, 0은 비활성화하지 않음입니다. |
| content.wsInfo.disableDataWriteAt | integer | 쓰기 금지 시간, Unix 초, 아직 설정되지 않은 경우 일반적으로 -1. |
| content.wsInfo.logBackupQueryTimeLimit | integer | 백업 로그 쿼리 기간 제한 값, 단위는 시간입니다. |
| content.wsInfo.engineSetting | object | 엔진 전용 설정 동적 객체입니다. 과거 nodegroup 필드는 출력에서 node_group으로 정규화됩니다. |
| content.wsInfo.enableAI | boolean | 워크스페이스 AI 총 스위치. |
| content.wsInfo.enableAPIKeySecurityDisplayPolicy | boolean | API Key 보안 표시 정책 스위치. |
| content.wsInfo.enableObsyAISubscriptionBilling | boolean | Obsy AI 구독 과금 스위치. |
| content.wsInfo.tokenIpSet | object 또는 null | 워크스페이스 Token의 IP 액세스 제한 설정 동적 객체입니다. 이 페이지에서는 반환만 하며, 이러한 요청 매개변수로 수정할 수 없습니다. |
| content.wsInfo.singleConfig | object 또는 null | 워크스페이스 기능 설정 동적 객체입니다. 워크스페이스에 이미 있는 설정을 기준으로 하며, 여기서 고정된 설정 키를 보장하지 않습니다. |
| content.wsInfo.issueUpgrade | boolean | 인시던트 에스컬레이션 기능 스위치. |
| content.wsInfo.durationSet.{데이터 유형} | string | 해당 데이터 유형의 표준 보존 기간입니다. 예: rp, logging, keyevent, tracing, rum, apm, network, backup_log. 현재 설정에 따라 다른 읽기 전용 키가 있을 수 있습니다. |
| content.wsInfo.storagePolicy.{데이터 유형} | object | 해당 유형의 장기 정책이며 일반적으로 rp, logging을 사용합니다. |
| content.wsInfo.storagePolicy.{데이터 유형}.longStorageEnabled | boolean | 장기 스토리지 활성화 여부입니다. |
| content.wsInfo.storagePolicy.{데이터 유형}.longStorageDuration | string | 장기 총 보존 기간입니다. 예: 180d. 비활성화 후에는 일반적으로 빈 문자열입니다. |
| content.wsInfo.datastore.{데이터 유형} | string | 해당 유형에서 사용하는 엔진 이름입니다. 예: es, doris, scopedb, volctls, sls, guancedb. 인스턴스 UUID가 아닙니다. |
| content.wsInfo.declaration.organization | string | 조직 이름이며, 선언 설정이 있는 경우 제공됩니다. |
| content.wsInfo.declaration.business | string | 비즈니스 설명이며, 선언 설정이 있는 경우 제공됩니다. |
| content.wsInfo.esIndexSettings.{데이터 유형} | object | 해당 유형의 인덱스 설정입니다. |
| content.wsInfo.esIndexSettings.{데이터 유형}.number_of_shards | integer | 프라이머리 샤드 수이며, 엔진에 따라 표시 여부가 달라집니다. |
| content.wsInfo.esIndexSettings.{데이터 유형}.number_of_replicas | integer | 복제본 수. |
| content.wsInfo.esIndexSettings.{데이터 유형}.rollover_max_size | integer | 샤드 롤오버 임계값이며, 인터페이스는 엔진 정의에 따라 그대로 전달합니다. |
| content.wsInfo.esIndexSettings.{데이터 유형}.hot_retention | integer | 핫 데이터 보존 기간, 시간. |
| content.wsInfo.esIndexSettings.{데이터 유형}.cold_retention | integer | 선택적 콜드 데이터 보존 기간, 시간. |
| content.wsInfo.esIndexSettings.{데이터 유형}.archive_retention | integer | 선택적 아카이브 데이터 보존 기간, 시간. |
| content.wsInfo.esIndexSettings.{데이터 유형}.openAdvancedConfig | integer | 고급 설정 표시이며 일반적으로 0 또는 1입니다. |
| content.wsInfo.engineSetting.node_group | string | 선택적 엔진 노드 그룹 식별자이며, 기타 설정 항목은 해당 엔진에서 결정합니다. |
| content.wsInfo.bindInfo.{설정 항목} | JSON 값 | 기존 브랜드 재정의 값이며, 키 의미는 바인딩 정보 설정 인터페이스를 기준으로 합니다. |
| content.wsInfo.lastDqlDataCheckTime.{데이터 유형} | JSON 값 | 해당 유형의 시스템 유지 관리 검사 값이며 쿼리 결과가 아닙니다. |
| content.wsInfo.tokenIpSet.{설정 항목} | JSON 값 | 기존 Token IP 정책입니다. 읽은 후 구조를 유지하며, 이를 기반으로 External 인증 헤더를 구성하지 않습니다. |
| content.wsInfo.singleConfig.{설정 항목} | JSON 값 | 기존 기능 설정 값이며, 구체적인 유형과 키는 해당 기능 설정 규칙에 따릅니다. |
| content.makeResourceExceptionCode | string | 리소스 생성 문제 표시입니다. 빈 문자열, noPermissionCreateProject 또는 addDataStoreFailure입니다. 현재 주로 SLS/VolcTLS 데이터베이스 생성 결과에 사용되며, 다른 다운스트림 실패가 항상 이 필드에 기록되는 것은 아닙니다. |
{
"code": 200,
"content": {
"accountInfo": [
"acnt_example001"
],
"wsInfo": {
"id": 1001,
"uuid": "wksp_example001",
"status": 0,
"creator": "sys",
"updator": "",
"createAt": 1785427200,
"deleteAt": -1,
"updateAt": -1,
"name": "API示例空间",
"token": "<workspace-token>",
"cliToken": "<workspace-cli-token>",
"dbUUID": "ifdb_example001",
"esInstanceUUID": "esinst_example001",
"dashboardUUID": "",
"exterId": "",
"rpName": "",
"desc": "接口文档演示工作空间",
"durationSet": {
"rp": "7d",
"logging": "7d",
"keyevent": "7d",
"tracing": "7d",
"rum": "7d",
"network": "1d"
},
"storagePolicy": {},
"datastore": {
"metric": "guancedb",
"logging": "doris",
"keyevent": "doris",
"tracing": "doris",
"rum": "doris",
"network": "doris",
"lineage": "doris"
},
"lastDqlDataCheckTime": {},
"declaration": {
"organization": "示例组织",
"business": ""
},
"esIndexSettings": {},
"bindInfo": {},
"versionType": "unlimited",
"billingState": "normal",
"bossStation": "",
"brandKey": "guance",
"enablePublicDataway": 1,
"isOpenLogMultipleIndex": true,
"esIndexMerged": 0,
"supportJsonMessage": 1,
"isLocked": 0,
"lockMode": "none",
"lockAt": -1,
"delayDeleteAt": -1,
"inviteAudit": 0,
"makeResourceExceptionCode": "",
"loggingCutSize": 10240,
"language": "zh",
"noviceGuide": false,
"timezone": "",
"menuStyle": "",
"tenantId": -1,
"isOpenCustomMappingRule": 0,
"enableRumMultipleTable": 1,
"enableMFA": false,
"disableQueryAcceleration": 0,
"disableDataWrite": 0,
"disableDataWriteAt": -1,
"logBackupQueryTimeLimit": 24,
"engineSetting": {},
"enableAI": false,
"enableAPIKeySecurityDisplayPolicy": false,
"enableObsyAISubscriptionBilling": false,
"tokenIpSet": {},
"singleConfig": {},
"issueUpgrade": true
},
"makeResourceExceptionCode": ""
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
다음 표는 이 인터페이스의 비즈니스 검증 및 확인된 주요 오류 분기를 나열합니다. 다운스트림 서비스는 구체적인 오류 매핑에 따라 다른 4xx 오류를 반환할 수도 있습니다. 일반 5xx 및 알 수 없는 예외는 전역 처리에 따라 ft.InternalServerError를 반환합니다. 쓰기 요청은 현재 설정과 오류 content를 함께 고려하여 적용 여부를 판단해야 하며, HTTP 상태만으로 롤백을 추론해서는 안 됩니다.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다 | 매개변수 구문 분석 실패 | 매개변수 위치, 필드 이름, 유형 및 값을 확인하십시오. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않습니다 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정하십시오. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아닙니다 | 일부 json 파일 형식 오류 | 매개변수 표에 따라 JSON 객체를 제출하고, 배열이나 null을 전체 요청 본문으로 사용하지 마십시오. |
| 406 | ft.InvalidBrandKey | brandKey가 사이트 허용 집합에 없습니다 | 브랜드 식별자 {}이(가) 유효하지 않습니다. |
사이트 관리자에게 허용된 브랜드 식별자를 확인하십시오. |
| 404 | ft.NotFoundAccount | ownerUuid가 존재하지 않거나 삭제된 계정을 가리킵니다 | 지정한 계정을 찾을 수 없습니다 | 계정 목록에서 유효한 계정을 선택하십시오. |
| 404 | ft.NamespaceDatastoreNotFound | 워크스페이스 기본 데이터 유형에 해당 스토리지 엔진 설정이 없습니다 | {}의 스토리지 유형을 찾을 수 없습니다 |
관리자에게 사이트 데이터 유형 및 스토리지 설정을 보완해 달라고 요청하십시오. |
| 404 | ft.NoExistsTimeDbInstance | 사이트에 활성 기본 시계열 데이터베이스 인스턴스가 없습니다 | 시계열 데이터베이스 설정을 찾을 수 없습니다 | 관리자가 먼저 사이트 시계열 스토리지 설정을 완료하도록 하십시오. |
| 406 | ft.InvalidParameterV2 | storageTypeUUID가 활성 스토리지 인스턴스를 가리키지 않습니다 | 매개변수 {}의 값 {}이(가) 유효하지 않습니다 |
관리자에게 유효한 로그 인스턴스 UUID를 다시 받으십시오. |
| 406 | ft.ForbiddenExmergeStoreageBoth | 명시적 storageTypeUUID와 esIndexMerged=true를 동시에 사용했습니다 | 인덱스 병합이 활성화된 경우 스토리지 유형을 선택할 수 없습니다 | esIndexMerged=false로 설정하거나 storageTypeUUID를 생략하고 기본 인스턴스를 사용하십시오. |
| 400 | ft.LogIndexCfgQuantityIllegal | SLS/Beaver의 logMultipleIndexCount가 0보다 작습니다 | 잘못된 로그 다중 인덱스 수량입니다 | 음수가 아닌 정수를 사용하며, 수량 상한이 필요하면 양수를 사용하십시오. |
| 406 | ft.CurrentVersionUnsupportRp | 해당 버전의 기본 보존 정책이 없거나 RP에 사용 가능한 설정을 가져올 수 없습니다 | 현재 버전은 rp:{}을(를) 지원하지 않습니다 |
해당 사이트에서 확인된 기본 보존 기간을 사용하고, 관리자에게 워크스페이스 버전 설정을 확인해 달라고 요청하십시오. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시, 리소스 서비스 또는 처리되지 않은 매개변수 변환 예외입니다 | 내부 오류 | traceId를 저장하고 관리자에게 문의하십시오. 먼저 설정과 다운스트림 실제 상태를 조회해야 하며, 실패 응답을 곧바로 저장되지 않은 것으로 간주하거나 무작정 반복 생성 또는 교체하지 마십시오. |