수정¶
POST /api/v1/workspace/{workspace_uuid}/modify
개요¶
워크스페이스 이름, 쿼리 스위치, 멀티 인덱스 및 데이터 보존 정책을 조정합니다.
호출 전 및 사용 단계¶
먼저 워크스페이스 상세와 인덱스 템플릿 목록을 읽고 기존 구성을 저장합니다. 수정할 필드만 제출하고, 일반 스토리지의 경우 현재 isOpenLogMultipleIndex를 명시적으로 포함하여 생략 시 멀티 인덱스가 꺼지는 것을 방지합니다. 보존 기간을 수정하면 조회 가능 범위에 영향을 주며, 기간을 줄이면 만료 데이터 정리가 트리거될 수 있습니다. 인덱스 병합 모드를 전환하면 보존 기간이 재계산되고 사용자 정의 템플릿이 비워집니다. 성공 후 상세와 인덱스 템플릿을 다시 읽어 대조하고 데이터 조회/수집을 확인합니다. 이 작업은 먼저 저장한 후 다운스트림에 동기화할 수 있으므로, 실패 후에는 구성과 실제 리소스를 각각 확인해야 합니다.
경로 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| workspace_uuid | string | Y | 대상 워크스페이스 UUID이며 계정 UUID나 수집 Token이 아닙니다. 예: wksp_example001획득 또는 입력 방법: 워크스페이스 목록의 content.data[].uuid 또는 생성 성공 시 content.wsInfo.uuid에서 가져오고, 사이트와 워크스페이스 이름을 확인합니다. |
요청 헤더¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| storagePolicy.rp | object | 메트릭 장기 저장 구성이며, 제출하지 않은 다른 카테고리는 유지됩니다. 이 카테고리에 빈 객체를 전달하면 비활성화로 처리됩니다. 예: {"longStorageEnabled": false}획득 또는 입력 방법: 현재 인덱스 템플릿 목록의 storagePolicy.rp에서 가져와 대상 정책에 맞게 수정합니다. |
|
| storagePolicy.rp.longStorageEnabled | boolean | false는 명시적으로 비활성화하고 true는 활성화합니다. 카테고리 객체가 있지만 이 키를 생략하면 false로 정규화되어 기존 정책이 비활성화될 수 있습니다. 기존 정책을 유지하려면 전체 카테고리 객체를 생략해야 합니다. 비활성화해도 표준 durationSet은 변경되지 않습니다. 예: false획득 또는 입력 방법: 장기 보존이 필요한지에 따라 JSON 불리언 값을 선택합니다. |
|
| storagePolicy.rp.longStorageDuration | string | 활성화 시 입력하며, 비활성화 시 생략할 수 있습니다. 표준 기간과 장기 기간을 직접 더하지 마십시오. 예: 180d획득 또는 입력 방법: 사이트에서 허용하는 장기 기간 중에서 선택하며, 해당 유형의 현재 또는 이번 표준 보존 기간보다 커야 합니다. |
|
| storagePolicy.logging | object | 로그 장기 저장 구성이며, 제출하지 않은 다른 카테고리는 유지됩니다. 이 카테고리에 빈 객체를 전달하면 비활성화로 처리됩니다. 예: {"longStorageEnabled": false}획득 또는 입력 방법: 현재 인덱스 템플릿 목록의 storagePolicy.logging에서 가져와 대상 정책에 맞게 수정합니다. |
|
| storagePolicy.logging.longStorageEnabled | boolean | false는 명시적으로 비활성화하고 true는 활성화합니다. 카테고리 객체가 있지만 이 키를 생략하면 false로 정규화되어 기존 정책이 비활성화될 수 있습니다. 기존 정책을 유지하려면 전체 카테고리 객체를 생략해야 합니다. 비활성화해도 표준 durationSet은 변경되지 않습니다. 예: false획득 또는 입력 방법: 장기 보존이 필요한지에 따라 JSON 불리언 값을 선택합니다. |
|
| storagePolicy.logging.longStorageDuration | string | 활성화 시 입력하며, 비활성화 시 생략할 수 있습니다. 표준 기간과 장기 기간을 직접 더하지 마십시오. 예: 180d획득 또는 입력 방법: 사이트에서 허용하는 장기 기간 중에서 선택하며, 해당 유형의 현재 또는 이번 표준 보존 기간보다 커야 합니다. |
|
| disableQueryAcceleration | integer | 선택적 정수 0/1이며, 생략하면 유지됩니다. null을 허용한다고 선언되어 있지만 현재 구현에서는 int(null)이 500을 발생시키므로 클라이언트는 null을 전달하지 마십시오. null 허용: True 선택 가능한 값: [0, 1] 예: 0획득 또는 입력 방법: 현재 상세에서 읽은 후 0(비활성화하지 않음) 또는 1(비활성화)을 선택합니다. |
|
| durationSet | object | 선택적 객체이며, 값은 일수에 소문자 d를 붙인 형식입니다. 생략하면 유지되며, 실제로 지원되는 데이터 유형 키만 병합하고 빈 객체는 비우지 않습니다. 수정 전에 버전에서 변경을 지원하는지 확인해야 하며, 보존 기간을 낮추면 조회 가능한 데이터에 영향을 줍니다. 예: {"logging": "7d"}획득 또는 입력 방법: 먼저 인덱스 템플릿 목록에서 현재 durationSet, esIndexMerged 및 datastore를 가져온 후 실제 버전/엔진에 맞게 선택합니다. |
|
| durationSet.apm | string | 병합 인덱스의 애플리케이션 성능 데이터 표준 보존 기간입니다. 현재 인덱스 분할/병합 모드에서 이 키를 지원할 때만 업데이트되며, 다른 모드에서는 무시될 수 있습니다. 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을 허용한다고 선언되어 있지만 현재 구현에서는 int(null)이 500을 발생시키므로 클라이언트는 null을 전달하지 마십시오. null 허용: True 선택 가능한 값: [0, 1] 예: 1획득 또는 입력 방법: RUM 데이터 테이블 분할 필요에 따라 1(활성화) 또는 0(비활성화)을 선택합니다. |
|
| esIndexMerged | boolean | 선택 사항이며, 생략하면 유지됩니다. logging=es인 경우에만 전환할 수 있습니다. 전환하면 일부 보존 정책이 재계산되고 워크스페이스 사용자 정의 인덱스 설정이 비워지므로 먼저 템플릿을 백업해야 합니다. null 허용: False 예: false획득 또는 입력 방법: 먼저 인덱스 템플릿 목록에서 현재 esIndexMerged와 datastore.logging을 확인합니다. |
|
| isOpenCustomMappingRule | boolean | 선택적 불리언 값이며, 생략하면 유지됩니다. null일 수 없습니다. null 허용: False 예: false획득 또는 입력 방법: 먼저 워크스페이스 상세에서 현재 스위치를 읽은 후 조정 여부를 결정합니다. |
|
| isOpenLogMultipleIndex | boolean | 선택적 불리언 값이지만, 일반 스토리지에서 생략하면 false로 처리되어 신규 멀티 인덱스가 비활성화될 수 있습니다. SLS/Beaver에서는 이 스위치가 이 필드로 변경되지 않습니다. false여도 기존 인덱스는 삭제되지 않습니다. null 허용: False 예: true획득 또는 입력 방법: 워크스페이스 상세에서 현재 isOpenLogMultipleIndex를 읽고, 일반적인 수정 시 현재 값을 명시적으로 전달하여 유지합니다. |
|
| leftWildcard | boolean | 선택적 불리언 값이며, 생략하면 유지됩니다. false는 비활성화, true는 활성화이며 null일 수 없습니다. null 허용: False 예: false획득 또는 입력 방법: 선행 와일드카드 퍼지 쿼리 필요에 따라 선택하며, 유지해야 하면 생략합니다. |
|
| logMultipleIndexCount | int | 선택 사항이며, 생략하면 유지됩니다. 일반 스토리지는 >=1이어야 하고, SLS/Beaver는 >=0이어야 하며 0은 수량 제한 없음을 의미합니다. null일 수 없습니다. null 허용: False 예: 30획득 또는 입력 방법: 비즈니스 인덱스 수량에 맞게 선택하거나, 먼저 관리자에게 현재 수량 제한을 확인합니다. |
|
| loggingCutSize | int | 선택적 정수이며, 0이 아니고 값이 변경될 때 다운스트림에 알리고 업데이트합니다. 0은 분할을 비활성화하지도 않고 원래 값도 변경하지 않으며 null일 수 없습니다. null 허용: False 예: 10240획득 또는 입력 방법: 기존 loggingCutSize를 재사용하거나 실제 대형 로그 정책에 따라 바이트 수를 지정합니다. |
|
| maxSearchResultCount | integer | 선택적 정수이며, 생략하면 기존 구성이 수정되지 않습니다. 응답에서 같은 이름의 값이 생략되면 0이며, 이를 근거로 기존 구성이 비워졌다고 판단해서는 안 됩니다. null일 수 없습니다. null 허용: False 예: 0획득 또는 입력 방법: 클라이언트의 쿼리 결과 총량 필요에 따라 선택하며, 0은 여기서 추가 제한하지 않음을 의미합니다. |
|
| name | string | 선택 사항이며, 생략하면 유지됩니다. 최대 256자로 선언되어 있지만 저장 열과의 호환성을 위해 128자 이내를 권장합니다. null일 수 없습니다. null 허용: False 최대 길이: 256 예: API示例空间新名称획득 또는 입력 방법: 새로운 워크스페이스 표시 이름을 입력합니다. |
|
| storagePolicy | json | 선택적 객체이며 데이터 유형 키별로 업데이트되고 전체 교체가 아닙니다. 생략하거나 최상위 {}를 전달해도 기존 정책은 비워지지 않습니다. 특정 카테고리에 빈 객체를 전달하면 비활성화로 정규화됩니다. rp, logging만 사용하는 것을 권장하며, 특정 유형을 비활성화하려면 longStorageEnabled=false를 명시하십시오. null일 수 없습니다. 장기 저장은 총 보존 기간이며 해당 유형의 표준 보존 기간보다 커야 합니다. 로그는 scopedb이면서 pay/enterprise/unlimited인 경우에만 지원됩니다. 메트릭은 과금 유형에 부합해야 하며, pay와 청구 센터가 활성화된 unlimited는 metric_point_total을 요구하고 enterprise 등도 명시적인 timeseries 과금은 거부합니다. 저장소 기본값으로 pay 로그는 90d/120d/180d/360d를 선택할 수 있고, pay 메트릭은 추가로 540d/720d를 선택할 수 있습니다. enterprise/unlimited 로그는 1d~1800d, 메트릭은 1d~3600d를 허용하며 여전히 표준 보존 기간보다 커야 합니다. 실제 선택 가능한 집합과 범위는 사이트 구성으로 재정의됩니다. null 허용: False 예: {"logging": {"longStorageEnabled": false}}획득 또는 입력 방법: 인덱스 템플릿 목록에서 현재 storagePolicy와 durationSet을 읽고 엔진, 버전 및 과금 유형을 확인합니다. |
매개변수 추가 설명¶
w 권한이 있는 사이트 수준 External API 자격 증명을 사용합니다. 인증 방식은 External API 서명 인증을 참조하십시오. 예시는 v20240417에 따라 서명을 계산하며, 서명과 전송에는 동일한 경로, Query 및 원본 요청 본문을 사용합니다. 모든 예시는 데모 값이므로 실행 전에 실제 대상으로 교체하십시오. 쓰기 요청이 타임아웃되거나 500이 발생하면 먼저 현재 상태를 조회하고 확인한 후 재시도 여부를 결정해야 합니다.
장기 저장은 총 보존 기간이며 해당 유형의 표준 보존 기간보다 커야 합니다. 로그는 scopedb이면서 pay/enterprise/unlimited인 경우에만 지원됩니다. 메트릭은 과금 유형에 부합해야 하며, pay와 청구 센터가 활성화된 unlimited는 metric_point_total을 요구하고 enterprise 등도 명시적인 timeseries 과금은 거부합니다. 저장소 기본값으로 pay 로그는 90d/120d/180d/360d를 선택할 수 있고, pay 메트릭은 추가로 540d/720d를 선택할 수 있습니다. enterprise/unlimited 로그는 1d~1800d, 메트릭은 1d~3600d를 허용하며 여전히 표준 보존 기간보다 커야 합니다. 실제 선택 가능한 집합과 범위는 사이트 구성으로 재정의됩니다.
요청 예시¶
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/wksp_example001/modify'
query = {}
data = {'name': 'API示例空间新名称', 'isOpenLogMultipleIndex': True}
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.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.maxSearchResultCount | integer | 이번에 파싱된 최대 검색 결과 수입니다. 이 입력 파라미터를 생략하면 0을 반환하며, 기존 구성에는 여전히 0이 아닌 값이 남아 있을 수 있습니다. |
{
"code": 200,
"content": {
"wsInfo": {
"id": 1001,
"uuid": "wksp_example001",
"status": 0,
"creator": "sys",
"updator": "sys",
"createAt": 1785427200,
"deleteAt": -1,
"updateAt": 1785427200,
"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": 1,
"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
},
"maxSearchResultCount": 0
},
"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.NotFoundWorkspace | 워크스페이스가 없거나 삭제되었거나 현재 활성 상태 조회 조건을 충족하지 않음 | 지정한 워크스페이스를 찾을 수 없음 | 워크스페이스 목록에서 유효한 UUID를 다시 가져오고 상태를 확인합니다. |
| 429 | ft.OperationTooFrequently | 동일 워크스페이스의 스토리지 구성 잠금이 점유되었거나 실행 중 잠금 소유권이 상실됨 | 작업이 너무 빈번합니다. 잠시 후 다시 시도하십시오. | 잠시 후 먼저 현재 구성을 읽고 새로운 nonce와 서명으로 재시도합니다. 실행 중 잠금을 상실한 경우 모든 쓰기가 발생하지 않았다고 단정할 수 없습니다. |
| 400 | ft.InvalidActionForbiddenChange | 비ES가 병합 상태 전환을 시도하거나 버전/엔진/과금 유형이 요청된 장기 저장을 지원하지 않음 | 구체적인 분기에 따라 반환되며, 예: "로그가 scopedb 스토리지인 워크스페이스에서만 장기 저장 정책을 활성화할 수 있습니다" | 실제 datastore와 과금 유형에 따라 요청을 조정합니다. |
| 400 | ft.LogIndexCfgQuantityIllegal | 일반 스토리지 인덱스 수량이 1 미만이거나 SLS/Beaver 수량이 0 미만 | 잘못된 로그 멀티 인덱스 수량 | 스토리지 유형에 따라 수량을 수정합니다. |
| 400 | ft.FreeWKSPLimit | 무료 플랜에서 표준 보존 기간 또는 장기 저장 정책 변경 시도 | 유효하지 않은 작업입니다. 현재 워크스페이스는 무료 플랜입니다. | 현재 보존 기간을 유지하거나 정식 업그레이드 절차를 통해 워크스페이스 버전을 변경합니다. |
| 400 | ft.IllegalDataKeepTime | pay 버전에서 변경한 표준 보존 기간이 해당 사이트 허용 집합에 없음 | 잘못된 데이터 보존 기간 | 사이트에서 선택 가능한 표준 보존 기간 중에서 선택합니다. |
| 406 | ft.InvalidDuration | 보존 기간이 숫자+d 형식이 아니거나 장기 보존 기간이 해당 버전 허용 집합에 없음 | 유효하지 않은 duration | 표의 형식과 해당 사이트 범위를 사용하며, 장기 보존 기간은 표준 값보다 커야 합니다. |
| 406 | ft.InvalidDurationRange | enterprise/unlimited 사용자 정의 보존 기간이 범위를 벗어났거나 장기 보존 기간이 표준 보존 기간보다 크지 않음 | 유효한 데이터 보존 기간 범위를 초과함 | 사이트 허용 범위에 따라 표준 및 장기 보존 기간을 조정합니다. |
| 406 | ft.CurrentVersionUnsupportRp | 현재 버전이 요청된 보존 정책 편집을 지원하지 않음 | 현재 버전은 rp:{}를 지원하지 않습니다. |
관리자에게 워크스페이스 버전과 스토리지 구성을 확인하십시오. |
| 500 | ft.InternalServerError | 데이터베이스, 캐시, 리소스 서비스 또는 처리되지 않은 매개변수 변환 예외 | 내부 오류 | traceId를 저장하여 관리자에게 문의하고, 먼저 구성과 다운스트림 실제 상태를 조회해야 합니다. 실패 응답을 곧바로 저장되지 않은 것으로 간주하지 말고, 무작정 반복 생성하거나 교체하지 마십시오. |